Docs
API reference

Tasks

Download spec

List tasks

GET
/tasks

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from Settings → Developers → API keys.

Response Body

Success. Writes without read permission return an ID and revision only.

application/json
  1. response
runs*array<>
Example Request
curl -X GET 'https://app.italic.com/api/v2/tasks'
Example Response
{
  "runs": [
    {
      "id": "string",
      "source": "chat",
      "recordingId": "string",
      "status": "running",
      "reply": "string",
      "error": "string",
      "prompt": "string",
      "workflows": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "actions": [
        {
          "id": "string",
          "tool": "string",
          "status": "proposed",
          "executor": "cloud",
          "args": {},
          "result": {},
          "link": "string",
          "workflowId": "string"
        }
      ],
      "questions": [
        {
          "id": "string",
          "prompt": "string",
          "about": "string",
          "kind": "recipient",
          "choices": [
            {
              "label": "string",
              "detail": "string"
            }
          ]
        }
      ],
      "createdAt": 0,
      "updatedAt": 0
    }
  ]
}

Approve or discard a draft

POST
/runs/{id}/actions/{actionId}/decision

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from Settings → Developers → API keys.

Path Parameters

id*string
Match^[A-Za-z0-9][A-Za-z0-9._:-]*$
Length1 <= length <= 256
actionId*string
Match^[A-Za-z0-9][A-Za-z0-9._:-]*$
Length1 <= length <= 256

Request Body

application/json
  1. body
decision*string
Value in"approve""reject"
tool?string

The draft's tool, as you showed it to the person. Required to approve.

Length1 <= length <= 64
args?

Edited fields of an email, event or reminder draft, replacing its args. Omit to approve it as drafted.

Response Body

Success. Writes without read permission return an ID and revision only.

application/json
  1. response
run*
replayed?boolean
Example Request
curl -X POST 'https://app.italic.com/api/v2/runs/string/actions/string/decision' \
  -H 'Content-Type: application/json' \
  -d '{
  "decision": "approve"
}'
Example Response
{
  "run": {
    "id": "string",
    "source": "chat",
    "recordingId": "string",
    "status": "running",
    "reply": "string",
    "error": "string",
    "prompt": "string",
    "workflows": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "actions": [
      {
        "id": "string",
        "tool": "string",
        "status": "proposed",
        "executor": "cloud",
        "args": {},
        "result": {},
        "link": "string",
        "workflowId": "string"
      }
    ],
    "questions": [
      {
        "id": "string",
        "prompt": "string",
        "about": "string",
        "kind": "recipient",
        "choices": [
          {
            "label": "string",
            "detail": "string"
          }
        ]
      }
    ],
    "createdAt": 0,
    "updatedAt": 0
  },
  "replayed": true
}

Answer a question

POST
/runs/{id}/questions/{questionId}/answer

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from Settings → Developers → API keys.

Path Parameters

id*string
Match^[A-Za-z0-9][A-Za-z0-9._:-]*$
Length1 <= length <= 256
questionId*string
Match^[A-Za-z0-9][A-Za-z0-9._:-]*$
Length1 <= length <= 256

Request Body

application/json
  1. body
choice?integer

Index of one of the question's choices.

Range0 <= value <= 50
text?string

A typed answer. A recipient question needs an email address in it.

Length1 <= length <= 2000
dismiss?boolean

true skips the question; the workflow ends there.

Response Body

Success. Writes without read permission return an ID and revision only.

application/json
  1. response
run*
replayed?boolean
Example Request
curl -X POST 'https://app.italic.com/api/v2/runs/string/questions/string/answer' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "run": {
    "id": "string",
    "source": "chat",
    "recordingId": "string",
    "status": "running",
    "reply": "string",
    "error": "string",
    "prompt": "string",
    "workflows": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "actions": [
      {
        "id": "string",
        "tool": "string",
        "status": "proposed",
        "executor": "cloud",
        "args": {},
        "result": {},
        "link": "string",
        "workflowId": "string"
      }
    ],
    "questions": [
      {
        "id": "string",
        "prompt": "string",
        "about": "string",
        "kind": "recipient",
        "choices": [
          {
            "label": "string",
            "detail": "string"
          }
        ]
      }
    ],
    "createdAt": 0,
    "updatedAt": 0
  },
  "replayed": true
}

Chat

Previous Page

Workflows

Next Page