Deep Research

Advanced research operations

Get all deep research requests

get

Retrieves all deep research requests made by the authenticated user

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved deep research requests

application/json

idstringOptional

The request ID

Example: 550e8400-e29b-41d4-a716-446655440000

requestedOnstring · date-timeOptional

When the request was made

Example: 2024-01-15T10:30:00Z

succeededOnstring · date-timeOptional

When the request was completed

Example: 2024-01-15T10:35:00Z

statusintegerOptional

Request status (0=pending, 5=processing, 100=completed)

Example: 100

errorOnstring · date-timeOptional

When the error occurred

errorMessagestringOptional

Error message if request failed

errorCodeintegerOptional

Error code if request failed

Example: 0

promptstringOptional

The research query text

Example: What are the latest developments in artificial intelligence?

outputTypestringOptional

Output format used for the response (text or json)

Example: json

jsonFormatstringOptional

JSON formatting instructions applied when outputType is json

Example: {"summary":"","keyInsights":[]}

isScheduleTemplatebooleanOptional

True if this item is a schedule template rather than an executed request

Example: true

scheduleIdstringOptional

The ID of the schedule template

Example: 550e8400-e29b-41d4-a716-446655440000

dailyCountintegerOptional

Number of times per day this schedule will execute

Example: 2

scheduleEndDatestring · date-timeOptional

End date for the schedule, or null if it runs indefinitely

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

lastScheduleExecutionOnstring · date-timeOptional

The most recent time this schedule executed

Example: 2024-01-16T09:00:00Z

nextScheduleExecutionOnstring · date-timeOptional

The next scheduled execution time

Example: 2024-01-16T12:00:00Z

get

/deep-research/research

HTTPcURLJavaScriptPython

GET /deep-research/research HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
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?",
    "outputType": "json",
    "jsonFormat": "{\"summary\":\"\",\"keyInsights\":[]}",
    "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

textstringRequired

The research query text

Example: What are the latest developments in artificial intelligence?

outputTypestring · enumRequired

The format of the output result. When set to json, the response is serialized JSON.

Example: jsonPossible values:

jsonFormatstringOptional

Optional instructions or template describing the JSON structure to generate.

Example: { "summary": "", "keyFindings": [], "sources": [] }

providerstring · enumOptional

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

Example: geminiPossible values:

projectIdsstring[]Optional

Optional array of project IDs to add context from their descriptions

Example: ["proj-123","proj-456"]

filesstring[]Optional

Optional array of file URLs or uploaded file IDs (from /files) to attach to the research request

Example: ["https://example.com/reference.pdf","2c9fe88f-d3e2-41a8-9156-76c5e34dbfdd"]

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

or

400

Bad request - validation error or unauthorized access

application/json

401

Unauthorized - invalid or missing token

application/json

500

Internal server error

application/json

post

/deep-research/research

HTTPcURLJavaScriptPython

POST /deep-research/research HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 432

{
  "text": "What are the latest developments in artificial intelligence?",
  "outputType": "json",
  "jsonFormat": "{\n  \"summary\": \"\",\n  \"keyFindings\": [],\n  \"sources\": []\n}\n",
  "provider": "gemini",
  "projectIds": [
    "proj-123",
    "proj-456"
  ],
  "files": [
    "https://example.com/reference.pdf",
    "2c9fe88f-d3e2-41a8-9156-76c5e34dbfdd"
  ],
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the deep research request to retrieve

Responses

200

Successfully retrieved deep research request

application/json

idstringOptional

The request ID

Example: 550e8400-e29b-41d4-a716-446655440000

requestedOnstring · date-timeOptional

When the request was made

Example: 2024-01-15T10:30:00Z

succeededOnstring · date-timeOptional

When the request was completed

Example: 2024-01-15T10:35:00Z

statusintegerOptional

Request status (0=pending, 5=processing, 100=completed)

Example: 100

errorOnstring · date-timeOptional

When the error occurred

errorMessagestringOptional

Error message if request failed

errorCodeintegerOptional

Error code if request failed

Example: 0

promptstringOptional

The research query text

Example: What are the latest developments in artificial intelligence?

outputTypestringOptional

Output format used for the response (text or json)

Example: json

jsonFormatstringOptional

JSON formatting instructions applied when outputType is json

Example: {"summary":"","keyInsights":[]}

isScheduleTemplatebooleanOptional

True if this item is a schedule template rather than an executed request

Example: true

scheduleIdstringOptional

The ID of the schedule template

Example: 550e8400-e29b-41d4-a716-446655440000

dailyCountintegerOptional

Number of times per day this schedule will execute

Example: 2

scheduleEndDatestring · date-timeOptional

End date for the schedule, or null if it runs indefinitely

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

lastScheduleExecutionOnstring · date-timeOptional

The most recent time this schedule executed

Example: 2024-01-16T09:00:00Z

nextScheduleExecutionOnstring · date-timeOptional

The next scheduled execution time

Example: 2024-01-16T12:00:00Z

responseTextstringOptional

The research result content. When outputType is json, this value is a serialized JSON string.

Example: {"summary":"AI advancements","keyInsights":["..."]}

404

Deep research request not found

application/json

500

Internal server error

application/json

get

/deep-research/research/{id}

HTTPcURLJavaScriptPython

GET /deep-research/research/{id} HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
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?",
  "outputType": "json",
  "jsonFormat": "{\"summary\":\"\",\"keyInsights\":[]}",
  "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": "{\"summary\":\"AI advancements\",\"keyInsights\":[\"...\"]}"
}

Get recurring deep research templates

get

Returns all recurring deep research templates for the authenticated user with their configuration and scheduling details.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved recurring templates

application/json

successbooleanOptionalExample: true

400

Bad request - amateur subscription

application/json

401

Unauthorized - invalid or missing token

application/json

500

Internal server error

application/json

get

/deep-research/recurring

HTTPcURLJavaScriptPython

GET /deep-research/recurring HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "templates": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "text": "Latest developments in quantum computing",
      "provider": "gemini",
      "outputType": "json",
      "jsonFormat": "{\"summary\":\"\",\"takeaways\":[]}",
      "deletedOn": null,
      "callbackData": "user-data-123",
      "dailyCount": 2,
      "scheduleEndDate": "2024-12-31T23:59:59Z",
      "lastRunAt": "2024-01-15T10:30:00Z",
      "nextRunAt": "2024-01-15T14:30:00Z",
      "createdOn": "2024-01-01T00:00:00Z"
    }
  ]
}

Update a recurring deep research template

post

Updates specific fields of a recurring template. Can be used to pause/resume, change frequency, update end date, or modify the research text.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the recurring template to update

Example: 550e8400-e29b-41d4-a716-446655440000

Body

application/json

textstringOptional

New research query text

Example: Updated research on AI ethics

dailyCountinteger · min: 1 · max: 24Optional

New number of executions per day

Example: 3

scheduleEndDatestring · date-time · nullableOptional

New end date for the recurring executions (null to remove end date)

Example: 2025-01-31T23:59:59Z

isActivebooleanOptional

Set to false to pause the recurring template, true to resume

Example: false

Responses

200

Recurring template updated successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Recurring template updated successfully

templateobjectOptional

The updated template with all fields (same structure as GET /deep-research/recurring response items)

400

Bad request - validation error or amateur subscription

application/json

401

Unauthorized - invalid or missing token

application/json

404

Recurring template not found or unauthorized

application/json

500

Internal server error

application/json

post

/deep-research/recurring/{id}

HTTPcURLJavaScriptPython

POST /deep-research/recurring/{id} HTTP/1.1
Host: api.autocontentapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "text": "Updated research on AI ethics",
  "dailyCount": 3,
  "scheduleEndDate": "2025-01-31T23:59:59Z",
  "isActive": false
}

{
  "success": true,
  "message": "Recurring template updated successfully",
  "template": {}
}