Skip to main content
POST
/
api
/
tasks
cURL
curl --request POST \
  --url https://recoup-api.vercel.app/api/tasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Weekly Genre Pulse Check",
  "prompt": "Execute this weekly genre analysis workflow and email a summary to the team.",
  "schedule": "0 9 * * 4",
  "artist_account_id": "1873859c-dd37-4e9a-9bac-80d35a1b2c3d",
  "account_id": "848cd58d-700f-4b38-ab4c-d9f52a1b2c3d"
}
'
{
  "status": "success",
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "prompt": "<string>",
      "schedule": "<string>",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "artist_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enabled": true,
      "trigger_schedule_id": "<string>",
      "recent_runs": [
        {
          "id": "<string>",
          "status": "PENDING_VERSION",
          "taskIdentifier": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "idempotencyKey": "<string>",
          "version": "<string>",
          "isTest": true,
          "startedAt": "2023-11-07T05:31:56Z",
          "finishedAt": "2023-11-07T05:31:56Z",
          "delayedUntil": "2023-11-07T05:31:56Z",
          "ttl": "<unknown>",
          "expiredAt": "2023-11-07T05:31:56Z",
          "tags": [
            "<string>"
          ],
          "metadata": {},
          "costInCents": 123,
          "baseCostInCents": 123,
          "durationMs": 123,
          "env": {
            "id": "<string>",
            "name": "<string>",
            "user": "<string>"
          },
          "depth": 123,
          "batchId": "<string>",
          "triggerFunction": "trigger",
          "payload": "<unknown>",
          "output": "<unknown>",
          "error": {
            "message": "<string>",
            "name": "<string>",
            "stackTrace": "<string>"
          },
          "attempts": [
            {
              "id": "<string>",
              "status": "PENDING",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "startedAt": "2023-11-07T05:31:56Z",
              "completedAt": "2023-11-07T05:31:56Z",
              "error": {
                "message": "<string>",
                "name": "<string>",
                "stackTrace": "<string>"
              }
            }
          ],
          "schedule": {},
          "relatedRuns": {}
        }
      ],
      "upcoming": [
        "2023-11-07T05:31:56Z"
      ],
      "owner_email": "<string>",
      "model": "<string>"
    }
  ],
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.recoupable.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Task to create

​
title
string
required

Descriptive title of the task

Example:

"Weekly Genre Pulse Check"

​
prompt
string
required

Instruction/prompt executed by the task

Example:

"Execute this weekly genre analysis workflow and email a summary to the team."

​
schedule
string
required

Cron expression defining when the task runs (e.g., '0 9 * * 4' for Thursdays at 9 AM)

Example:

"0 9 * * 4"

​
artist_account_id
string<uuid>
required

UUID of the associated artist account

Example:

"1873859c-dd37-4e9a-9bac-80d35a1b2c3d"

​
account_id
string<uuid>

UUID of the account to create the task for. Only applicable when the authenticated account has access to multiple accounts via organization membership. If not provided, the task is created for the API key's own account.

Example:

"848cd58d-700f-4b38-ab4c-d9f52a1b2c3d"

Response

Task created successfully

​
status
enum<string>
required

Status of the request

Available options:
success,
error
​
tasks
object[]
required

Array of task objects

​
error
string

Error message (only present if status is error)