By prompt

Ask in plain English and get a graph back, with a written explanation.

POST/api/v2.0-preview/atlas/graphs/prompt

Authorizations

Bearer

Authorizationstringrequiredheader

Required Bearer API key: your NOSIBLE API key from the API Dashboard.

Example: Bearer nos_sk_...

Body

application/json

promptstringrequiredbody

The question, up to 8,000 characters.

Example: How is Nvidia connected to OpenAI?

sessionstringbody

Session id from a previous response. Continues the conversation and the graph on screen.

Example: as_3565eeb24b3721a2

limitintegerbody

Maximum relationships drawn. Defaults to 300, maximum 1,000.

Example: 10

streambooleanbody

When true the response is NDJSON: activity lines while the graph is built, then one reply line.

Example: false

as_ofdatebody

Point in time (YYYY-MM-DD). Only events dated on or before it count. Defaults to the latest date in the release. `to` is accepted as the same parameter, as in the World API.

Example: 2024-12-31

fromdatebody

Optional start of the evidence window (YYYY-MM-DD, inclusive).

Example: 2020-01-01

How to use this endpoint

guidance

Use By prompt when you would rather describe the graph than build it from parameters. A language model plans the query, Atlas runs it on the graph, and the explanation is written only from what the graph contains. Expect 5 to 25 seconds. Pass the returned session to refine the same graph in a follow-up question. The graph and the explanation vary from run to run, because the model plans each answer afresh: the example is one real response, which the same request will not repeat word for word.

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

idstring

Id of this answer (ap_ followed by 16 hex characters).

sessionstring

Session id to send with a follow-up prompt (as_ followed by 16 hex characters).

messagestring

The explanation of the graph, in Markdown.

graphobject

{nodes, edges, count, total, truncated}. nodes carry focus: true for the entities you asked about; edges are relationships, strongest first; total counts edges before the limit.

schemastring

Response schema name.

as_ofdate

The point in time the answer is computed for.

date_windowobject

The evidence window: from, to, archive_cutoff and include_live (always false).

releasestring

Immutable id of the graph release that answered.

took_msinteger

Server time in milliseconds.

Responses and errors

HTTP

200Request succeeded. The response body is shown in the panel on the right.

400invalid_request — A parameter is missing, malformed or out of range; the message names it.

400invalid_entity_type — The entity type is not one Atlas holds. TICKER is refused: send the company as an ORG.

400unknown_predicate — A relationship type is not in the graph; list them with Relationship types.

401api_key_required — No API key was sent. Send it as Authorization: Bearer <key> or the api-key header.

401invalid_api_key — The API key is invalid or has been revoked.

404unknown_entity — No entity of that type has that name in this release. When the name exists under another type, the message says which.

404not_found — No endpoint matches this method and path.

410cursor_expired — The cursor belongs to another release or request; restart from the first page.

422unprocessable_request — Each value is valid but not together, such as from after as_of.

422request_too_broad — The request ran out of its work budget before it could answer; narrow it.

429rate_limited — Too many requests for this key; wait for Retry-After.

501backend_not_configured — The Atlas backend is not configured for this deployment.

502backend_error — The Atlas backend could not be reached; retry shortly.

503unavailable — The service is busy or starting; retry after Retry-After.

503api_key_auth_unavailable — API key authentication is temporarily unavailable; retry shortly.

504request_timeout — The request took longer than 25 seconds; narrow it.

504backend_timeout — The Atlas backend did not answer before the deadline; retry.

409session_busy — The session's previous prompt is still running; wait for it before sending the next one.

410session_expired — The session is unknown or has expired; start a new conversation without session.

502upstream_error — The language model failed; retry.

504upstream_timeout — The language model did not answer in time; retry.