Parse a Git repository

curl --request POST \
  --url https://your-instance.example.com/api/parse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repoUrl": "https://github.com/your-org/your-repo"
}
'

{
  "message": "Parse queued",
  "project": "/your-org/your-repo",
  "queueId": 5,
  "position": 1
}

{
  "error": "repoUrl is required"
}

{
  "error": "Authentication required"
}

{
  "error": "An unexpected error occurred"
}

POST

parse

curl --request POST \
  --url https://your-instance.example.com/api/parse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repoUrl": "https://github.com/your-org/your-repo"
}
'

{
  "message": "Parse queued",
  "project": "/your-org/your-repo",
  "queueId": 5,
  "position": 1
}

{
  "error": "repoUrl is required"
}

{
  "error": "Authentication required"
}

{
  "error": "An unexpected error occurred"
}

Authorizations

Authorization

string

header

required

API key generated from Personal Settings. See Authentication.

Body

application/json

repoUrl

string<uri>

required

HTTPS URL of the GitHub or GitLab repository

branch

string

Branch to parse. Defaults to the repository's default branch

folders

string[]

Only index files under these paths. Empty means the entire repository

excludeFolders

string[]

Paths to skip during indexing

excludeFiles

string[]

Glob patterns for files to exclude

force

boolean

default:false

Re-parse even if the current commit is already indexed

Response

Parse job accepted and queued

message

string

required

Example:

"Parse queued"

project

string

required

Project identifier assigned to this library (e.g. /your-org/your-repo)

Example:

"/your-org/your-repo"

queueId

integer

required

Numeric ID for this parse job

Example:

5

position

integer | null

Position in the queue. null if the job started immediately

Example:

1

Get documentation context Parse an OpenAPI spec by URL

⌘I

Overview

How To

Enterprise

Security

Clients

SDKs

Agentic Tools

API Reference

Integrations

Resources

Authorizations

Body

Response