API reference

VoiceJob

The objects, fields and constraints behind the API.

Field	Type & constraints
`id`required	string
`accountId`required	string
`state`required	enumValues: pending, running, succeeded, failed, canceled.
`stage`required	enumValues: fetch, analyze, synthesize, evaluate, complete.
`chunk`required	integer
`fetchedPosts`required	integer
`pages`required	integer
`analyzedChunks`required	integer
`errorCode`required	string \| null
`createdAt`required	integer
`finishedAt`required	integer \| null

View JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "accountId": {
      "type": "string"
    },
    "state": {
      "enum": [
        "pending",
        "running",
        "succeeded",
        "failed",
        "canceled"
      ]
    },
    "stage": {
      "enum": [
        "fetch",
        "analyze",
        "synthesize",
        "evaluate",
        "complete"
      ]
    },
    "chunk": {
      "type": "integer"
    },
    "fetchedPosts": {
      "type": "integer"
    },
    "pages": {
      "type": "integer"
    },
    "analyzedChunks": {
      "type": "integer"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "integer"
    },
    "finishedAt": {
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "accountId",
    "state",
    "stage",
    "chunk",
    "fetchedPosts",
    "pages",
    "analyzedChunks",
    "errorCode",
    "createdAt",
    "finishedAt"
  ],
  "additionalProperties": true
}

← All data models