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"
}Parse
Parse a Git repository
Queue a GitHub or GitLab repository for parsing and indexing
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
API key generated from Personal Settings. See Authentication.
Body
application/json
HTTPS URL of the GitHub or GitLab repository
Branch to parse. Defaults to the repository's default branch
Only index files under these paths. Empty means the entire repository
Paths to skip during indexing
Glob patterns for files to exclude
Re-parse even if the current commit is already indexed
Response
Parse job accepted and queued
Example:
"Parse queued"
Project identifier assigned to this library (e.g. /your-org/your-repo)
Example:
"/your-org/your-repo"
Numeric ID for this parse job
Example:
5
Position in the queue. null if the job started immediately
Example:
1
Was this page helpful?