TSGGLOBAL Support sign in
Skip to page content
Browse TNID API docs

TNID API documentation User Documents Get One User AI Task

Get One User AI Task

On this page

GraphQL endpoint: /user

A single task by id, for a client that has one and nothing else — a link to a task's runs, say. Null when the id isn't the caller's, which reads the same as one that doesn't exist.

Query

query ($id: ID!) {
  aiTask(id: $id) {
    id
    name
    runOnRoot
    folders { id name }
    prompt
    outputShape
    documentCount
    inFlightCount
  }
}

Variables

{
  "id": "00000000-0000-4000-8000-000000000001"
}

Response

{
  "data": {
    "aiTask": {
      "documentCount": 1,
      "folders": [],
      "id": "00000000-0000-4000-8000-000000000001",
      "inFlightCount": 0,
      "name": "task-8",
      "outputShape": {
        "total": "number"
      },
      "prompt": "Extract the invoice details from this document.",
      "runOnRoot": true
    }
  }
}