Submit a Context Graph ask

POST

/context-graph/asks

Submits a natural-language question about your team’s Context Graph.

Asks are asynchronous. On success, this returns an HTTP 202 Accepted response with the ask’s askId. Send a request to the GET /context-graph/asks/{askId} endpoint to poll the ask for its status and, once it completes, its result.

Note:

Postman derives the team from your API key.

Submits a natural-language question about your team's Context Graph. Asks are asynchronous. On success, this returns an HTTP `202 Accepted` response with the ask's `askId`. Send a request to the GET `/context-graph/asks/{askId}` endpoint to poll the ask for its status and, once it completes, its result. **Note:** Postman derives the team from your API key.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

querystringRequired1-2000 characters

The natural-language question to answer against the graph.

includeAnswerbooleanOptionalDefaults to true

Whether to include the prose answer in the result. If false, the result’s answer property is null and the result’s other properties are unaffected.

maxStepsintegerOptional1-15Defaults to 10

The maximum number of tool calls the ask can make. Must be between 1 and 15.

Response

Accepted

askIdstring

The created ask's ID. Use this value to poll the ask.

statusenum

The ask's lifecycle state.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error