API Documentation

Authentication

All API requests require an API key passed via the Authorization header.

1. Go to Dashboard → Settings
2. Click "Generate API Key"
3. Copy the key immediately — it is shown only once

curl https://repoclip.io/api/v1/credits \
  -H "Authorization: Bearer rc_live_YOUR_API_KEY"

Endpoints

curl -X POST https://repoclip.io/api/v1/generate \
  -H "Authorization: Bearer rc_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "github_url": "https://github.com/owner/repo",
    "mode": "image",
    "prompt": "Focus on the API features"
  }'

{
  "id": "a2140a91-...",
  "status": "pending",
  "credits_used": 10,
  "credits_remaining": 40,
  "estimated_time_seconds": 600,
  "poll_url": "https://repoclip.io/api/v1/projects/a2140a91-..."
}

curl https://repoclip.io/api/v1/projects/PROJECT_ID \
  -H "Authorization: Bearer rc_live_YOUR_API_KEY"

{
  "id": "a2140a91-...",
  "status": "completed",
  "video_url": "https://..../a2140a91.mp4",
  "thumbnail_url": "https://..../thumb.jpg",
  "share_url": "https://repoclip.io/v/a2140a91-...",
  "duration_seconds": 62,
  "resolution": "720p"
}

curl https://repoclip.io/api/v1/credits \
  -H "Authorization: Bearer rc_live_YOUR_API_KEY"

{
  "plan": "starter",
  "credits": 40,
  "costs": {
    "image": 10,
    "video_short": 40,
    "video_long": 300,
    "bgm_addon": 20
  }
}

Error Codes

All errors follow the format: {"error": {"code": "...", "message": "..."}}

GitHub Action

Use our official GitHub Action to generate videos automatically in your CI/CD pipeline.

Setup

1. Generate an API key in Settings
2. Add it as a repository secret named REPOCLIP_API_KEY
3. Create a workflow file

Example: Generate on Release

name: Generate Demo Video
on:
  release:
    types: [published]

jobs:
  video:
    runs-on: ubuntu-latest
    steps:
      - uses: repoclip/generate-video@v1
        id: video
        with:
          api-key: ${{ secrets.REPOCLIP_API_KEY }}
          mode: image
          prompt: "Highlight the new features in this release"

      - name: Add video link to release
        if: steps.video.outputs.status == 'completed'
        uses: actions/github-script@v7
        with:
          script: |
            const body = context.payload.release.body || '';
            github.rest.repos.updateRelease({
              owner: context.repo.owner,
              repo: context.repo.repo,
              release_id: context.payload.release.id,
              body: body + '\n\n---\n[Watch demo video](${{ steps.video.outputs.share-url }})'
            });

Action Inputs

Action Outputs

Rate Limits