Deep Research

Advanced research operations

Get all deep research requests

get

Retrieves all deep research requests made by the authenticated user

Authorizations
Responses
200

Successfully retrieved deep research requests

application/json
get
GET /deep-research/research HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer JWT
Accept: */*
200

Successfully retrieved deep research requests

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "requestedOn": "2024-01-15T10:30:00Z",
    "succeededOn": "2024-01-15T10:35:00Z",
    "status": 100,
    "errorOn": null,
    "errorMessage": null,
    "errorCode": 0,
    "prompt": "What are the latest developments in artificial intelligence?",
    "isScheduleTemplate": true,
    "scheduleId": "550e8400-e29b-41d4-a716-446655440000",
    "dailyCount": 2,
    "scheduleEndDate": "2024-12-31T23:59:59Z",
    "lastScheduleExecutionOn": "2024-01-16T09:00:00Z",
    "nextScheduleExecutionOn": "2024-01-16T12:00:00Z"
  }
]

Perform deep research on a given query

post

Conducts advanced research on the provided text query and returns results in the specified output format

Authorizations
Body
textstringRequired

The research query text

Example: What are the latest developments in artificial intelligence?
outputTypestring ยท enumRequired

The format of the output result

Example: textPossible values:
providerstring ยท enumOptional

The AI provider to use for research (defaults to gemini)

Example: geminiPossible values:
callbackDatastringOptional

Optional callback data to be returned with the response

Example: user-specific-data
isScheduledbooleanOptional

If true, creates a recurring schedule instead of a one-time request

Example: false
dailyCountinteger ยท min: 1 ยท max: 24Optional

Number of times per day to execute the research (default 1, only used when isScheduled is true)

Example: 2
scheduleEndDatestring ยท date-timeOptional

Optional end date for the schedule (only used when isScheduled is true). If not provided, schedule runs indefinitely.

Example: 2024-12-31T23:59:59Z
Responses
200

Research request or schedule submitted successfully

application/json
Responseone of
or
post
POST /deep-research/research HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "text": "What are the latest developments in artificial intelligence?",
  "outputType": "text",
  "provider": "gemini",
  "callbackData": "user-specific-data",
  "isScheduled": false,
  "dailyCount": 2,
  "scheduleEndDate": "2024-12-31T23:59:59Z"
}
{
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Get a specific deep research request by ID

get

Retrieves a single deep research request by its unique ID

Authorizations
Path parameters
idstringRequired

The ID of the deep research request to retrieve

Responses
200

Successfully retrieved deep research request

application/json
get
GET /deep-research/research/{id} HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer JWT
Accept: */*
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "requestedOn": "2024-01-15T10:30:00Z",
  "succeededOn": "2024-01-15T10:35:00Z",
  "status": 100,
  "errorOn": null,
  "errorMessage": null,
  "errorCode": 0,
  "prompt": "What are the latest developments in artificial intelligence?",
  "isScheduleTemplate": true,
  "scheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "dailyCount": 2,
  "scheduleEndDate": "2024-12-31T23:59:59Z",
  "lastScheduleExecutionOn": "2024-01-16T09:00:00Z",
  "nextScheduleExecutionOn": "2024-01-16T12:00:00Z",
  "responseText": "Based on recent research, artificial intelligence has made significant advances in..."
}