Execute job

POST /api/v1/jobs/execute

Dynamic based on action Permission: jobs:write

Runs a billable job by action name and parameters, deducting credits accordingly.

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Request body JSON required

action: required transcribe_video_summary|generate_embeddings_batch|dispatch_webhook_event

Name of the job action to execute
params: optional object

Arbitrary parameters for the job action

Returns

200

Job executed successfully

JSON

success: required boolean
action: required string
credits_deducted: required integer
remaining_credits: required integer
processed_at: required string

format: date-time
output: required string

400

Bad request (invalid parameter or unknown action)

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

401

Missing or invalid API key or OAuth access token

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

402

Insufficient credit balance to execute the requested job

JSON

error: required string

Human-readable error message
error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.

403

Insufficient permissions or scope for this endpoint

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

404

Requested user or resource not found

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

409

Conflict (e.g. duplicate transaction or idempotent request collision)

JSON

error: required string

Human-readable error message
error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.

429

Rate limit or daily request quota exceeded

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

500

Internal server error

JSON

error: required string

Human-readable error message
error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.