For the complete documentation index, see llms.txt. This page is also available as Markdown.

Generate

Generate Content

post

Create a new AI content generation job.

Authorizations
x-api-keystringRequired
Body
modelstringRequired

Model name to use for generation

inputobjectRequired

Model-specific input parameters (varies by model)

webhookstring · uriOptional

URL where the job result will be sent upon completion

Responses
200

Generation job created successfully

application/json
jobIdstringOptional

Unique job identifier

statusstringOptionalExample: pending
post/generate
POST /v1/generate HTTP/1.1
Host: api.deepixels.co
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "model": "text",
  "input": {},
  "webhook": "https://example.com"
}
{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending"
}

Get Generation Job

get

Retrieve details of a specific generation job by its ID.

Authorizations
x-api-keystringRequired
Query parameters
jobIdstringRequired

Unique job identifier

Responses
200

Job details retrieved successfully

application/json
jobIdstringOptional

Unique job identifier

modelstringOptional

Model name used for generation

statusstring · enumOptional

Current job status

Possible values:
inputobjectOptional

Input parameters used for generation

webhookstring · uri · nullableOptional

Webhook URL configured for this job

datenumberOptional

Job creation timestamp in milliseconds since epoch

get/get
GET /v1/get?jobId=text HTTP/1.1
Host: api.deepixels.co
x-api-key: YOUR_API_KEY
Accept: */*
{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "model": "fast-video",
  "status": "processing",
  "input": {
    "prompt": "A beautiful sunset",
    "resolution": "720p"
  },
  "webhook": "https://example.com/webhook",
  "date": 1706745600000,
  "output": null
}

Last updated