Read a run

curl --request GET \
  --url https://gateway.apiosk.com/v2/runs/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://gateway.apiosk.com/v2/runs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

GET

runs

{id}

Read a run

curl --request GET \
  --url https://gateway.apiosk.com/v2/runs/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://gateway.apiosk.com/v2/runs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

Authorizations

Authorization

string

header

required

An organisation API key: Authorization: Bearer apk_org_live_…

Path Parameters

string<uuid>

required

Query Parameters

wait_seconds

integer

default:25

Required range: 0 <= x <= 55

limit

integer

Required range: 1 <= x <= 50

Response

Success

string<uuid>

status

enum<string>

Available options:

requires_approval,

running,

completed,

partial,

needs_input,

needs_selection,

unsupported,

cancelled,

failed

question

string

plan

object

Show child attributes

answer

object | null

Apiosk's reading of the results, with evidence pointers. Null for a direct call.

data

object

The source document, when the run produced exactly one.

results

object[]

Show child attributes

usage

object

Show child attributes

balance

object

Show child attributes

errors

object[]

Show child attributes

retry_after_ms

integer

Buy data

Operating it

API Reference

Read a run

Authorizations

Path Parameters

Query Parameters

Response