Skip to main content
POST
/
v1
/
projects
/
{project_id}
/
indexes
/
{index_id}
/
navigate
Navigate Index
curl --request POST \
  --url https://api.example.com/v1/projects/{project_id}/indexes/{index_id}/navigate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>' \
  --data '
{
  "query": "<string>",
  "current_node_id": "<string>",
  "top_k": 5
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication

​
x-selected-account-id
string
header
required

Selected Account ID

Path Parameters

​
project_id
string
required
​
index_id
string
required

Body

application/json

Request body for navigating an index.

​
query
string
required

Navigation query

​
current_node_id
string | null

Node ID to navigate from (None for root)

​
top_k
integer
default:5

Number of results to return

Response

Successful Response