Query Status

curl --request GET \
  --url "https://api.roe-ai.com/v1/database/query/YOUR_QUERY_ID/status/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

{
  "worksheet_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

GET

database

query

{worksheet_query_id}

status

curl --request GET \
  --url "https://api.roe-ai.com/v1/database/query/YOUR_QUERY_ID/status/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

{
  "worksheet_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

curl --request GET \
  --url "https://api.roe-ai.com/v1/database/query/YOUR_QUERY_ID/status/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

Authorizations

Authorization

string

header

required

Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.

Path Parameters

worksheet_query_id

string<uuid>

required

Query Parameters

organization_id

string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Response

worksheet_query_id

string<uuid>

required

The query task UUID.

status

string

required

The status of the query task.

error

string | null

An error message if the query failed.

created_at

string<date-time>

When the query was created.

finished_at

string<date-time> | null

When the query finished.

Run Query Async Query Result

API Documentation

Agents

Database

Roe Datasets

Policies

Webhooks

Authorizations

Path Parameters

Query Parameters

Response