Appearance
REST reference
Every endpoint the backend exposes: 138 operations across 106 paths, generated from the application's own OpenAPI schema so it cannot drift from the code.
See REST API for authentication, error shapes, a worked request and response, and how the interactive schema is exposed.
Request bodies are documented in full at the bottom of this page. The response column names a model rather than listing its fields: a response is read as it arrives, and the 182 response models would be bulk nobody navigates. Where a response shape matters before you call — the retrieval envelope in particular — it is shown on the page for that feature.
Reading the tables
A * marks a required parameter. Path parameters are omitted from the parameters column because they are visible in the path, and the Authorization, X-CSRF-Token and Idempotency-Key headers are omitted because they are cross-cutting rather than per-operation.
A — in the request column means the schema declares no body. Usually that is because there is none — POST /api/repos/{…}/reindex needs no payload. On the upload, OIDC-callback and webhook routes it means something different: the handler reads the raw body itself instead of declaring a model, so the schema cannot describe a shape that does exist. Each of those is documented on the page for its feature.
The response column is the status the schema declares, which is not always the only one a caller sees: an endpoint that rejects every request still declares a success status, and the purpose column says so where that happens. Error shapes are on REST API.
Health
Liveness. Mounted twice so probes need not know the API prefix.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/health | Get Health | — | — | 200 HealthResponse |
GET /health | Get Health | — | — | 200 HealthResponse |
Authentication
Session lifecycle: config, first-admin bootstrap, register, login, logout, refresh — plus the OIDC login, callback and account-linking routes.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
POST /api/auth/bootstrap | Create the first admin when no admin exists yet | — | BootstrapRequest | 200 LoginResponse |
GET /api/auth/config | Get Auth Config | — | — | 200 AuthConfigResponse |
POST /api/auth/login | Login | — | LoginRequest | 200 LoginResponse |
POST /api/auth/logout | Logout | — | — | 204 |
GET /api/auth/me | Get Current User Profile | — | — | 200 UserResponse |
GET /api/auth/oidc/{slug}/callback | Oidc Callback Get | code, state | — | 302 |
POST /api/auth/oidc/{slug}/callback | Used by IdPs configured with response_mode=form_post | — | — | 302 |
POST /api/auth/oidc/{slug}/link/start | Oidc Link Start | — | — | 302 |
GET /api/auth/oidc/{slug}/login | Oidc Login | return_to | — | 302 |
POST /api/auth/refresh | Rotate refresh token, check family reuse, issue new pair | — | — | 200 LoginResponse |
POST /api/auth/register | Always 403 — self-service registration is not exposed over the API | — | — | 200 |
Current user
The caller's own identities and query history.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/me/identities | List My Identities | — | — | 200 IdentityListResponse |
DELETE /api/me/identities/{identity_id} | Unlink My Identity | — | — | 204 |
Personal access tokens
Mint, list, rotate and revoke tokens for REST and MCP.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/admin/users/{user_id}/tokens | Admin List User Tokens | — | — | 200 TokenListResponse |
POST /api/admin/users/{user_id}/tokens/revoke-all | Mass-revoke every active PAT for a target user | — | RevokeAllRequest | 200 RevokeAllResponse |
GET /api/me/tokens | List My Tokens | — | — | 200 TokenListResponse |
POST /api/me/tokens | Create My Token | — | CreateTokenRequest | 201 CreateTokenResponse |
DELETE /api/me/tokens/{token_id} | Revoke My Token | — | — | 204 |
POST /api/me/tokens/{token_id}/rotate | Atomically revoke an existing token and mint a replacement | — | — | 201 CreateTokenResponse |
Repositories
Create, configure, index and delete repositories, including zip upload.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/repos | List Repositories | page, per_page, search, status | — | 200 RepositoryListResponse |
POST /api/repos | Create Repository | — | CreateRepositoryRequest | 202 RepositoryResponse |
POST /api/repos/upload | Create a new repository sourced from an uploaded zip archive | — | form data | 202 RepositoryResponse |
GET /api/repos/{host}/{owner}/{name} | Get Repository | — | — | 200 RepositoryResponse |
PATCH /api/repos/{host}/{owner}/{name} | Update Repository | — | UpdateRepositoryRequest | 200 RepositoryResponse |
DELETE /api/repos/{host}/{owner}/{name} | Delete Repository | — | — | 204 |
GET /api/repos/{host}/{owner}/{name}/files/{source_file_id} | Get Repository Source File | — | — | 200 SourceFileResponse |
GET /api/repos/{host}/{owner}/{name}/files/{source_file_id}/range | Get Repository Source File Range | start, end | — | 200 SourceFileRangeResponse |
GET /api/repos/{host}/{owner}/{name}/graph | Get Repository Graph | view, node_type, language, module, search, depth, limit | — | 200 GraphListResponse |
GET /api/repos/{host}/{owner}/{name}/graph/nodes/by-qn/{qualified_name} | Resolve a code node by its qualified_name for the current repo | — | — | 200 GraphNodeDetailResponse |
POST /api/repos/{host}/{owner}/{name}/graph/nodes/check | Check Repository Graph Nodes | — | GraphNodesCheckRequest | 200 GraphNodesCheckResponse |
GET /api/repos/{host}/{owner}/{name}/graph/nodes/{node_id} | Get Repository Graph Node | — | — | 200 GraphNodeDetailResponse |
POST /api/repos/{host}/{owner}/{name}/reindex | Reindex Repository | — | — | 202 RepoReindexResponse |
POST /api/repos/{host}/{owner}/{name}/runs/{run_id}/cancel | Force-cancel a wedged QUEUED/RUNNING repo_sync_runs row | — | — | 200 RepoSyncRunResponse |
POST /api/repos/{host}/{owner}/{name}/upload | Replace the persisted archive for a zip-source repository | — | form data | 202 RepoReindexResponse |
POST /api/repos/{host}/{owner}/{name}/webhook | Trigger Repository Webhook | x-cograph-webhook-secret | — | 202 RepoWebhookTriggerResponse |
Generated wiki
Read the generated page tree and individual pages; repair stale citations.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/repos/{host}/{owner}/{name}/wiki | Get Wiki Tree | — | — | 200 WikiTreeResponse |
GET /api/repos/{host}/{owner}/{name}/wiki/{slug} | Get Wiki Page | — | — | 200 WikiPageResponse |
POST /api/repos/{host}/{owner}/{name}/wiki/{slug}/repair-citations | Repair Wiki Page Citations | — | — | 200 WikiCitationRepairResponse |
Repository docs (rendered)
The repository's own in-tree markdown, rendered as pages.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/repos/{host}/{owner}/{name}/docs | Return nested doc tree for a repo | — | — | 200 DocTreeResponse |
GET /api/repos/{host}/{owner}/{name}/docs/{slug} | Return a single doc page by slug | — | — | 200 DocPageResponse |
Repository documents (indexed rows)
The document rows behind the rendered tree above — one per indexed file.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/repos/{host}/{owner}/{name}/documents | List Repository Documents | page, per_page, search | — | 200 RepoDocumentListResponse |
GET /api/repos/{host}/{owner}/{name}/documents/{document_id} | Get Repository Document | — | — | 200 RepoDocumentDetailResponse |
Retrieval
Hybrid search — the REST mirror of the MCP retrieve tool.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
POST /api/retrieve | Retrieve | — | RetrievalRequest | 200 RetrievalResponse |
Source routing
Which repository or collection likely holds the answer.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
POST /api/route | Route Endpoint | — | RouteRequest | 200 RouteResponse |
Markdown collections
Uploaded document corpora: CRUD, upload, search, embedding and jobs.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/md-collections | List Md Collections | page, per_page, search | — | 200 MdCollectionListResponse |
POST /api/md-collections | Create Md Collection | — | CreateMdCollectionRequest | 201 MdCollectionDetailResponse |
GET /api/md-collections/-/jobs | List All Md Jobs | limit, status | — | 200 MdGlobalJobListResponse |
POST /api/md-collections/-/jobs/{job_id}/retry | Retry Md Job | — | — | 200 MdJobResponse |
GET /api/md-collections/{collection_id} | Get Md Collection | page, per_page, search | — | 200 MdCollectionDetailResponse |
PATCH /api/md-collections/{collection_id} | Update Md Collection | — | UpdateMdCollectionRequest | 200 MdCollectionDetailResponse |
DELETE /api/md-collections/{collection_id} | Delete Md Collection | — | — | 204 |
POST /api/md-collections/{collection_id}/documents | Upload Md Document | — | — | 201 MdDocumentUploadResponse |
POST /api/md-collections/{collection_id}/documents/batch | Upload Md Document Batch | — | MdDocumentBatchUploadRequest | 201 MdDocumentBatchUploadResponse |
GET /api/md-collections/{collection_id}/documents/{document_id} | Get Md Document | — | — | 200 MdDocumentDetailResponse |
DELETE /api/md-collections/{collection_id}/documents/{document_id} | Delete Md Document | — | — | 204 |
GET /api/md-collections/{collection_id}/documents/{document_id}/chunks | List Md Document Chunks | — | — | 200 MdChunkListResponse |
GET /api/md-collections/{collection_id}/embed-status | Get Md Collection Embed Status | — | — | 200 MdEmbedStatusResponse |
GET /api/md-collections/{collection_id}/jobs | List Md Collection Jobs | limit | — | 200 MdJobListResponse |
POST /api/md-collections/{collection_id}/re-embed | Reembed Md Collection | — | — | 200 MdJobResponse |
POST /api/md-collections/{collection_id}/search | Search Md Collection | — | MdCollectionSearchRequest | 200 MdCollectionSearchResponse |
Pipeline jobs
Sync batches, per-step jobs, retry and cancel.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/jobs | List Jobs | step, status, repo_id, batch_id, search, page, per_page | — | 200 SyncJobListResponse |
GET /api/jobs/batches | Return all batches (non-paginated), sorted newest-first by started_at | kind | — | 200 SyncBatchListResponse |
GET /api/jobs/batches/{batch_id} | Get Batch | — | — | 200 SyncBatchDetailResponse |
GET /api/jobs/stats | Get Stats | days | — | 200 SyncStatsResponse |
GET /api/jobs/{job_id} | Get Job | — | — | 200 SyncJobResponse |
POST /api/jobs/{job_id}/cancel | Cancel a queued or running job | — | — | 200 SyncJobResponse |
POST /api/jobs/{job_id}/retry | Requeue a failed job | — | — | 200 SyncJobResponse |
Query logs
Usage analytics for admins, and self-service history.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/admin/query-logs | Admin List Query Logs | page, per_page, user_id, repository_id, tool_name, status, zero_results, q, since, until | — | 200 QueryLogPage |
GET /api/admin/query-logs/stats | Admin Query Logs Stats | since, until, top_n | — | 200 QueryLogStats |
GET /api/admin/query-logs/stats/timeseries | Bucketed query counts + token/cost sums for the usage chart | since, until, bucket | — | 200 UsageTimeseries |
GET /api/admin/query-logs/stats/users | Per-user activity over the window — INCLUDING silent users | since, until | — | 200 UserUsageStats |
GET /api/me/query-logs | Me List Query Logs | page, per_page, repository_id, tool_name, status, q, since, until | — | 200 QueryLogPage |
DELETE /api/me/query-logs | Drop every query_log row belonging to the caller | — | — | 200 ForgetResponse |
Administration
One router tag covers the whole admin surface: users, groups and their repository/collection grants, git hosts and clone credentials, identity providers, SCIM clients and the SCIM event log.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/admin/git-hosts | List Git Hosts | — | — | 200 GitHostListResponse |
POST /api/admin/git-hosts | Create Git Host | — | CreateGitHostRequest | 201 GitHostView |
PATCH /api/admin/git-hosts/{host_id} | Update Git Host | — | UpdateGitHostRequest | 200 GitHostView |
DELETE /api/admin/git-hosts/{host_id} | Delete Git Host | — | — | 204 |
GET /api/admin/git-hosts/{host_id}/credentials | List Credentials | — | — | 200 CredentialListResponse |
POST /api/admin/git-hosts/{host_id}/credentials | Create Credential | — | CreateCredentialRequest | 201 CredentialView |
PATCH /api/admin/git-hosts/{host_id}/credentials/{credential_id} | Update Credential | — | UpdateCredentialRequest | 200 CredentialView |
DELETE /api/admin/git-hosts/{host_id}/credentials/{credential_id} | Delete Credential | — | — | 204 |
POST /api/admin/git-hosts/{host_id}/credentials/{credential_id}/test | Test Credential | — | TestCredentialRequest | 200 CredentialTestResult |
GET /api/admin/git-hosts/{host_id}/webhook-deliveries | List Webhook Deliveries | limit | — | 200 WebhookDeliveryListResponse |
GET /api/admin/groups | List Groups | — | — | 200 GroupListResponse |
POST /api/admin/groups | Create Group | — | CreateGroupRequest | 201 GroupResponse |
PATCH /api/admin/groups/{group_id} | Update Group | — | UpdateGroupRequest | 200 GroupResponse |
DELETE /api/admin/groups/{group_id} | Delete Group | — | — | 204 |
GET /api/admin/groups/{group_id}/collections | List Collection Grants | — | — | 200 CollectionGrantListResponse |
POST /api/admin/groups/{group_id}/collections | Put Collection Grant | — | PutCollectionGrantRequest | 200 CollectionGrantResponse |
DELETE /api/admin/groups/{group_id}/collections/{collection_id} | Delete Collection Grant | — | — | 204 |
GET /api/admin/groups/{group_id}/members | List Members | — | — | 200 GroupMembersResponse |
POST /api/admin/groups/{group_id}/members | Idempotent bulk member-add | — | AddMembersRequest | 200 AddMembersResponse |
DELETE /api/admin/groups/{group_id}/members/{user_id} | Remove Member | — | — | 204 |
GET /api/admin/groups/{group_id}/repositories | List Repository Grants | — | — | 200 RepositoryGrantListResponse |
POST /api/admin/groups/{group_id}/repositories | Upsert a (group, repository) grant | — | PutRepositoryGrantRequest | 200 RepositoryGrantResponse |
DELETE /api/admin/groups/{group_id}/repositories/{repository_id} | Delete Repository Grant | — | — | 204 |
GET /api/admin/identity-providers | List Identity Providers | — | — | 200 IdentityProviderListResponse |
POST /api/admin/identity-providers | Create Identity Provider | — | CreateIdentityProviderRequest | 201 IdentityProviderView |
PATCH /api/admin/identity-providers/{provider_id} | Update Identity Provider | — | UpdateIdentityProviderRequest | 200 IdentityProviderView |
DELETE /api/admin/identity-providers/{provider_id} | Delete Identity Provider | — | — | 204 |
POST /api/admin/identity-providers/{provider_id}/test | Probe the IdP discovery + JWKS endpoints with the configured client | — | — | 200 IdentityProviderTestResponse |
GET /api/admin/repos/{host}/{owner}/{name}/webhook | Get Repository Webhook Config | — | — | 200 RepoWebhookConfigResponse |
GET /api/admin/scim-clients | List Scim Clients | — | — | 200 SCIMClientListResponse |
POST /api/admin/scim-clients | Create Scim Client | — | CreateSCIMClientRequest | 201 SCIMClientCreated |
DELETE /api/admin/scim-clients/{client_id} | Revoke Scim Client | — | — | 204 |
POST /api/admin/scim-clients/{client_id}/rotate | Rotate Scim Client | — | — | 201 SCIMClientCreated |
GET /api/admin/scim-events | List Scim Events | client_id, target_user_id, status, since, limit | — | 200 SCIMEventListResponse |
GET /api/admin/users | List Users | — | — | 200 AdminUserListResponse |
POST /api/admin/users | Create User | — | CreateUserRequest | 201 AdminUserResponse |
PATCH /api/admin/users/{user_id} | Update User | — | UpdateUserRequest | 200 AdminUserResponse |
DELETE /api/admin/users/{user_id} | Delete User | — | — | 204 |
POST /api/admin/users/{user_id}/disable | Disable User | — | DisableUserRequest | 204 |
POST /api/admin/users/{user_id}/enable | Enable User | — | — | 204 |
LLM runtime
Per-role model assignment, embedding state and provider tests.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/admin/llm-runtime | List Assignments | — | — | 200 AssignmentsResponse |
GET /api/admin/llm-runtime/embedding-status | Get Embedding Status | — | — | 200 EmbeddingStatusView |
POST /api/admin/llm-runtime/reembed | Trigger Reembed | — | — | 202 ReembedAcceptedResponse |
POST /api/admin/llm-runtime/test | Probe (secret + model) without saving — owner only | — | AssignmentTestRequest | 200 AssignmentTestResponse |
PUT /api/admin/llm-runtime/{role} | Upsert Assignment | — | AssignmentRequest | 200 AssignmentView |
DELETE /api/admin/llm-runtime/{role} | Clear Assignment | — | — | 204 |
Provider secrets
Encrypted provider credentials.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/admin/secrets | List Secrets | — | — | 200 LLMSecretsListResponse |
POST /api/admin/secrets | Create Secret | — | SecretUpsertRequest | 201 LLMSecretResponse |
PUT /api/admin/secrets/{secret_id} | Update Secret | — | SecretUpsertRequest | 200 LLMSecretResponse |
DELETE /api/admin/secrets/{secret_id} | Delete Secret | — | — | 204 |
POST /api/admin/secrets/{secret_id}/test | Test Secret | — | — | 200 SecretTestResponse |
MCP briefing
The operator briefing injected into every MCP session.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /api/admin/mcp/briefing | Get Mcp Briefing | — | — | 200 McpBriefingResponse |
PATCH /api/admin/mcp/briefing | Update Mcp Briefing | — | McpBriefingPatchRequest | 200 McpBriefingResponse |
Inbound webhooks
Push events that trigger a sync.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
POST /api/webhooks/github/{host_slug} | Receive Github Webhook | — | — | 204 |
SCIM 2.0
User provisioning. Mounted at /scim/v2, outside the API prefix.
| Operation | Purpose | Parameters | Request | Response |
|---|---|---|---|---|
GET /scim/v2/ResourceTypes | Get Resource Types | — | — | 200 |
GET /scim/v2/Schemas | Get Schemas | — | — | 200 |
GET /scim/v2/ServiceProviderConfig | Get Service Provider Config | — | — | 200 |
GET /scim/v2/Users | List Users | — | — | 200 |
POST /scim/v2/Users | Create User | — | — | 201 |
GET /scim/v2/Users/{user_id} | Get User | — | — | 200 |
PUT /scim/v2/Users/{user_id} | Replace User | — | — | 200 |
PATCH /scim/v2/Users/{user_id} | Patch User | — | — | 200 |
DELETE /scim/v2/Users/{user_id} | Delete User | — | — | 204 |
Request bodies
The fields of every JSON request model above, so a call can be constructed from this page alone. Enum-valued fields show their members; Modes and lifecycles explains what each member means.
AddMembersRequest
| Field | Type | Required | Default |
|---|---|---|---|
user_ids | uuid[] | yes | — |
Rejects unknown fields.
AssignmentRequest
| Field | Type | Required | Default |
|---|---|---|---|
secret_id | uuid | yes | — |
model_name | string | yes | — |
reasoning_effort | string | no | — |
embedding_dim | integer | no | — |
extra_params | object | no | — |
Rejects unknown fields.
AssignmentTestRequest
| Field | Type | Required | Default |
|---|---|---|---|
role | string | yes | — |
secret_id | uuid | yes | — |
model_name | string | yes | — |
reasoning_effort | string | no | — |
Rejects unknown fields.
BootstrapRequest
| Field | Type | Required | Default |
|---|---|---|---|
setup_token | string | yes | — |
email | yes | — | |
password | string | yes | — |
name | string | no | Admin |
CreateCredentialRequest
| Field | Type | Required | Default |
|---|---|---|---|
label | string | yes | — |
token | string | yes | — |
is_default | boolean | no | false |
webhook_secret | string | no | — |
Rejects unknown fields.
CreateGitHostRequest
| Field | Type | Required | Default |
|---|---|---|---|
slug | string | yes | — |
display_name | string | yes | — |
kind | string | no | github |
base_url | string | yes | — |
api_url | string | yes | — |
git_host | string | yes | — |
enabled | boolean | no | true |
Rejects unknown fields.
CreateGroupRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | yes | — |
description | string | no | — |
oidc_provider_id | uuid | no | — |
oidc_group_name | string | no | — |
Rejects unknown fields.
CreateIdentityProviderRequest
| Field | Type | Required | Default |
|---|---|---|---|
slug | string | yes | — |
display_name | string | yes | — |
kind | string | no | oidc |
issuer_url | string | yes | — |
client_id | string | yes | — |
client_secret | string | no | — |
scopes | string[] | no | — |
response_mode | string | no | query |
groups_claim | string | no | — |
domain_allowlist | string[] | no | — |
auto_provision | boolean | no | true |
auto_link_on_verified_email | boolean | no | false |
admin_group_mode | string | no | ignore |
admin_groups | string[] | no | — |
enabled | boolean | no | true |
Rejects unknown fields.
CreateMdCollectionRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | yes | — |
description | string | no | — |
visibility | private | public | admin_only | no | private |
CreateRepositoryRequest
| Field | Type | Required | Default |
|---|---|---|---|
git_url | string | yes | — |
branch | string | no | — |
name | string | no | — |
sync_schedule | manual | hourly | daily | weekly | webhook | no | — |
visibility | public | admin_only | no | — |
host_id | uuid | no | — |
Rejects unknown fields.
CreateSCIMClientRequest
| Field | Type | Required | Default |
|---|---|---|---|
provider_id | uuid | yes | — |
name | string | yes | — |
scopes | string[] | no | — |
Rejects unknown fields.
CreateTokenRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | yes | — |
scopes | string[] | yes | — |
expires_at | date-time | no | — |
Rejects unknown fields.
CreateUserRequest
| Field | Type | Required | Default |
|---|---|---|---|
email | yes | — | |
password | string | yes | — |
name | string | no | — |
role | owner | admin | user | no | user |
Rejects unknown fields.
DisableUserRequest
| Field | Type | Required | Default |
|---|---|---|---|
reason | string | no | — |
Rejects unknown fields.
GraphNodesCheckRequest
| Field | Type | Required | Default |
|---|---|---|---|
node_ids | uuid[] | yes | — |
LoginRequest
| Field | Type | Required | Default |
|---|---|---|---|
email | string | yes | — |
password | string | yes | — |
McpBriefingPatchRequest
| Field | Type | Required | Default |
|---|---|---|---|
content | string | yes | — |
Rejects unknown fields.
MdCollectionSearchRequest
| Field | Type | Required | Default |
|---|---|---|---|
query | string | yes | — |
top_k | integer | no | 10 |
MdDocumentBatchItem
| Field | Type | Required | Default |
|---|---|---|---|
source_key | string | yes | — |
title | string | no | — |
content | string | yes | — |
MdDocumentBatchUploadRequest
| Field | Type | Required | Default |
|---|---|---|---|
documents | object[] | yes | — |
upload_job_id | uuid | no | — |
upload_total | integer | no | — |
upload_final | boolean | no | false |
PutCollectionGrantRequest
| Field | Type | Required | Default |
|---|---|---|---|
collection_id | uuid | yes | — |
level | read | write | yes | — |
Rejects unknown fields.
PutRepositoryGrantRequest
| Field | Type | Required | Default |
|---|---|---|---|
repository_id | uuid | yes | — |
level | read | write | yes | — |
Rejects unknown fields.
RetrievalIncludeRequest
| Field | Type | Required | Default |
|---|---|---|---|
chunks | boolean | no | true |
graph | boolean | no | false |
scores | boolean | no | false |
RetrievalRequest
| Field | Type | Required | Default |
|---|---|---|---|
query | string | yes | — |
repository_id | uuid | no | — |
stores | (ast | code | ast_summary | repo_doc)[] | no | — |
top_k | integer | no | 10 |
snippet_chars | integer | no | 600 |
as_of | date-time | no | — |
since | date-time | no | — |
until | date-time | no | — |
include | object | no | — |
RevokeAllRequest
| Field | Type | Required | Default |
|---|---|---|---|
reason | string | no | admin |
Rejects unknown fields.
RouteRequest
| Field | Type | Required | Default |
|---|---|---|---|
query | string | yes | — |
top_k | integer | no | 3 |
SecretUpsertRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | yes | — |
api_url | string | yes | — |
api_key | string | no | — |
Rejects unknown fields.
TestCredentialRequest
| Field | Type | Required | Default |
|---|---|---|---|
token | string | no | — |
Rejects unknown fields.
UpdateCredentialRequest
| Field | Type | Required | Default |
|---|---|---|---|
label | string | no | — |
token | string | no | — |
is_default | boolean | no | — |
webhook_secret | string | no | — |
clear_webhook_secret | boolean | no | false |
Rejects unknown fields.
UpdateGitHostRequest
| Field | Type | Required | Default |
|---|---|---|---|
display_name | string | no | — |
base_url | string | no | — |
api_url | string | no | — |
git_host | string | no | — |
enabled | boolean | no | — |
Rejects unknown fields.
UpdateGroupRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | no | — |
description | string | no | — |
oidc_provider_id | uuid | no | — |
oidc_group_name | string | no | — |
Rejects unknown fields.
UpdateIdentityProviderRequest
| Field | Type | Required | Default |
|---|---|---|---|
display_name | string | no | — |
issuer_url | string | no | — |
client_id | string | no | — |
client_secret | string | no | — |
scopes | string[] | no | — |
response_mode | string | no | — |
groups_claim | string | no | — |
domain_allowlist | string[] | no | — |
auto_provision | boolean | no | — |
auto_link_on_verified_email | boolean | no | — |
admin_group_mode | string | no | — |
admin_groups | string[] | no | — |
enabled | boolean | no | — |
Rejects unknown fields.
UpdateMdCollectionRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | no | — |
description | string | no | — |
visibility | private | public | admin_only | no | — |
UpdateRepositoryRequest
| Field | Type | Required | Default |
|---|---|---|---|
sync_schedule | manual | hourly | daily | weekly | webhook | no | — |
visibility | public | admin_only | no | — |
log_queries | boolean | no | — |
Rejects unknown fields.
UpdateUserRequest
| Field | Type | Required | Default |
|---|---|---|---|
name | string | no | — |
role | owner | admin | user | no | — |
password | string | no | — |
Rejects unknown fields.