Skip to main content

API Endpoint Catalog

Source-derived is not deployed. Every route below was found in service source code. That does not mean it is deployed, reachable from outside the platform, publicly supported, or that its declared authentication is enforced in any particular deployment.

Paths shown are service-local (effective_source_path). A gateway path is shown only where the API gateway's routing table and catch-all handler support it. See Authentication and conventions for how to read the auth column. Use the site search to find a route by name or path.

api-gateway​

6 of 16 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
GET/{service}/{path:path}
Generic proxy. Which upstream services it reaches is defined by the gateway routing table; it does not by itself make any upstream route externally available.
gateway--INDIRECT · AuthMiddlewareAUTHENTICATED_PUBLICsource
POST/{service}/{path:path}
Generic proxy. Which upstream services it reaches is defined by the gateway routing table; it does not by itself make any upstream route externally available.
gateway--INDIRECT · AuthMiddlewareAUTHENTICATED_PUBLICsource
PUT/{service}/{path:path}
Generic proxy. Which upstream services it reaches is defined by the gateway routing table; it does not by itself make any upstream route externally available.
gateway--INDIRECT · AuthMiddlewareAUTHENTICATED_PUBLICsource
DELETE/{service}/{path:path}
Generic proxy. Which upstream services it reaches is defined by the gateway routing table; it does not by itself make any upstream route externally available.
gateway--INDIRECT · AuthMiddlewareAUTHENTICATED_PUBLICsource
GET/health
Exempted from the gateway auth middleware by its path skip-list in source.
health--INDIRECT · AuthMiddlewarePUBLICsource
GET/version
Exempted from the gateway auth middleware by its path skip-list in source.
version--INDIRECT · AuthMiddlewarePUBLICsource

auth​

48 of 143 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
GET/.well-known/jwks.jsonjwksjwksUNKNOWN · --PUBLICsource
POST/auth/loginloginauthUNKNOWN · --PUBLICsource
POST/auth/logoutlogoutauthUNKNOWN · --PUBLICsource
POST/auth/refreshrefreshauthUNKNOWN · --PUBLICsource
GET/meget_my_identityidentityEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
GET/organizations/{organization_id}/memberslist_organization_membersorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
GET/organizations/{organization_id}/members/{user_id}/effective-permissionsget_organization_member_effective_permissionsorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
GET/organizations/{organization_id}/members/{user_id}/rolesget_organization_member_rolesorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
POST/organizations/{organization_id}/members/{user_id}/rolesassign_organization_member_rolesorganizationsEXPLICIT · get_current_user, _require_org_managerAUTHENTICATED_PUBLICsource
DELETE/organizations/{organization_id}/members/{user_id}/roles/{role_name}remove_organization_member_roleorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
GET/organizations/{organization_id}/permissionslist_organization_permissionsorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
GET/organizations/{organization_id}/roleslist_organization_rolesorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
POST/organizations/{organization_id}/rolescreate_organization_roleorganizationsEXPLICIT · get_current_user, _require_org_managerAUTHENTICATED_PUBLICsource
PUT/organizations/{organization_id}/roles/{role_id}update_organization_roleorganizationsEXPLICIT · get_current_user, _require_org_managerAUTHENTICATED_PUBLICsource
DELETE/organizations/{organization_id}/roles/{role_id}delete_organization_roleorganizationsEXPLICIT · _require_org_managerAUTHENTICATED_PUBLICsource
GET/orgslist_my_orgsorgsEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/orgscreate_orgorgsEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
GET/orgs/{org_id}get_orgorgsEXPLICIT · get_org_membership_or_platform_adminAUTHENTICATED_PUBLICsource
PATCH/orgs/{org_id}update_orgorgsEXPLICIT · get_current_user, require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
POST/orgs/{org_id}/inviteinvite_memberorgsEXPLICIT · get_current_user, require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
GET/orgs/{org_id}/memberslist_membersorgsEXPLICIT · require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
GET/orgs/{org_id}/members/{user_id}/rolesget_member_rolesorgsEXPLICIT · require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
POST/orgs/{org_id}/members/{user_id}/rolesassign_member_roleorgsEXPLICIT · get_current_user, require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
PUT/orgs/{org_id}/members/{user_id}/rolesupdate_member_rolesorgsEXPLICIT · get_current_user, require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
DELETE/orgs/{org_id}/members/{user_id}/roles/{role_id}remove_member_roleorgsEXPLICIT · require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
GET/orgs/{org_id}/roleslist_org_rolesorgsEXPLICIT · require_org_permission_or_platform_admin(MANAGE_ORG)AUTHENTICATED_PUBLICsource
GET/orgs/{org_id}/teamslist_teamsteamsEXPLICIT · get_org_membership_or_platform_adminAUTHENTICATED_PUBLICsource
POST/orgs/{org_id}/teamscreate_teamteamsEXPLICIT · get_current_user, require_org_permission_or_platform_admin(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
GET/orgs/{org_id}/teams/{team_id}get_team_detailteamsEXPLICIT · get_org_membership_or_platform_adminAUTHENTICATED_PUBLICsource
PATCH/orgs/{org_id}/teams/{team_id}rename_teamteamsEXPLICIT · require_team_manage_permission(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
DELETE/orgs/{org_id}/teams/{team_id}delete_teamteamsEXPLICIT · require_org_permission_or_platform_admin(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
POST/orgs/{org_id}/teams/{team_id}/inviteinvite_team_memberteamsEXPLICIT · get_current_user, require_team_manage_permission(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
POST/orgs/{org_id}/teams/{team_id}/leaveleave_teamteamsEXPLICIT · get_current_user, get_org_membership_or_platform_adminAUTHENTICATED_PUBLICsource
GET/orgs/{org_id}/teams/{team_id}/membersget_team_membersteamsEXPLICIT · get_org_membership_or_platform_adminAUTHENTICATED_PUBLICsource
PUT/orgs/{org_id}/teams/{team_id}/membersset_team_membersteamsEXPLICIT · require_org_permission_or_platform_admin(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
DELETE/orgs/{org_id}/teams/{team_id}/members/{user_id}remove_team_memberteamsEXPLICIT · require_team_manage_permission(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
PUT/orgs/{org_id}/teams/{team_id}/members/{user_id}/roleupdate_team_member_roleteamsEXPLICIT · require_team_manage_permission(MANAGE_TEAMS)AUTHENTICATED_PUBLICsource
GET/sessionslist_my_sessionssessionsEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
GET/sessions/{session_id}get_my_sessionsessionsEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/sessions/{session_id}/revokerevoke_my_sessionsessionsEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/users/me/mfa/challengeverify_mfa_challengemfaINDIRECT · verify_mfa_challengeAUTHENTICATED_PUBLICsource
GET/users/me/mfa/deviceslist_mfa_devicesmfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
DELETE/users/me/mfa/devices/{device_id}remove_mfa_devicemfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
GET/users/me/mfa/recovery-codesrecovery_codes_statusmfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/users/me/mfa/recovery-codesgenerate_recovery_codesmfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/users/me/mfa/recovery-codes/regenerateregenerate_recovery_codesmfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/users/me/mfa/totp/enrollstart_totp_enrollmentmfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource
POST/users/me/mfa/totp/verifyverify_totp_enrollmentmfaEXPLICIT · get_current_userAUTHENTICATED_PUBLICsource

billing​

14 of 19 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
GET/billing/invoices/{invoice_id}read_invoice_detailbillingEXPLICIT · get_authorized_invoiceAUTHENTICATED_PUBLICsource
GET/billing/invoices/{invoice_id}/line-itemsread_invoice_line_itemsbillingEXPLICIT · get_authorized_invoiceAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/allowancesread_allowance_usagebillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/cost-breakdownread_cost_breakdownbillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/cost-historyread_cost_historybillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/costsread_cost_summarybillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/invoicesread_invoicesbillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/payment-methodread_payment_methodbillingEXPLICIT · get_authorized_billing_callerAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/subscriptionread_subscription_summarybillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/subscription/usage-limitsread_subscription_usage_limitsbillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/summaryread_organization_billing_summarybillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/usageread_usage_summarybillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/billing/organizations/{organization_id}/usage-eventsread_usage_eventsbillingEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource
GET/entitlements/{organization_id}/checkread_entitlement_checkentitlementsEXPLICIT · get_authorized_organization_idAUTHENTICATED_PUBLICsource

model-registry​

21 of 24 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
GET/v1/aliases
via gateway: /model-registry/v1/aliases
api_aliases--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/artifacts
via gateway: /model-registry/v1/artifacts
api_artifacts--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/compare
via gateway: /model-registry/v1/compare
api_compare--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/hf/push
via gateway: /model-registry/v1/hf/push
hf_pushhuggingfaceEXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/hf/push/status/{job_id}
via gateway: /model-registry/v1/hf/push/status/{job_id}
hf_push_statushuggingfaceEXPLICIT · require_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/metrics
via gateway: /model-registry/v1/metrics
api_metrics--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/models
via gateway: /model-registry/v1/models
list_models--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/ownership/resolve
via gateway: /model-registry/v1/ownership/resolve
api_resolve_ownership--EXPLICIT · require_ownership_resolve_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/promote
via gateway: /model-registry/v1/promote
api_promote--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/register
via gateway: /model-registry/v1/register
api_register--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/resolve
via gateway: /model-registry/v1/resolve
api_resolve--EXPLICIT · require_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/runs/get
via gateway: /model-registry/v1/runs/get
api_run_get--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/runs/list
via gateway: /model-registry/v1/runs/list
api_runs_list--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/runs/log-batch
via gateway: /model-registry/v1/runs/log-batch
api_log_batch--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/runs/log-metric
via gateway: /model-registry/v1/runs/log-metric
api_log_metric--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/runs/log-param
via gateway: /model-registry/v1/runs/log-param
api_log_param--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
GET/v1/show
via gateway: /model-registry/v1/show
api_show--EXPLICIT · require_read_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/stage
via gateway: /model-registry/v1/stage
api_set_stage--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
PUT/v1/tags
via gateway: /model-registry/v1/tags
api_set_tag--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/verify
via gateway: /model-registry/v1/verify
api_verify--EXPLICIT · require_auth_with_contextAUTHENTICATED_PUBLICsource
POST/v1/versions/patch
via gateway: /model-registry/v1/versions/patch
api_patch_version--EXPLICIT · require_write_auth_with_contextAUTHENTICATED_PUBLICsource

rag​

7 of 13 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
POST/v1/embed
via gateway: /rag/v1/embed
embed--EXPLICIT · require_permission(DATASET_WRITE)AUTHENTICATED_PUBLICsource
POST/v1/ingest
via gateway: /rag/v1/ingest
ingest--EXPLICIT · require_permission(DATASET_WRITE)AUTHENTICATED_PUBLICsource
GET/v1/kg/drug-disease
via gateway: /rag/v1/kg/drug-disease
kg_drug_disease--EXPLICIT · require_dataset_readAUTHENTICATED_PUBLICsource
GET/v1/kg/entity
via gateway: /rag/v1/kg/entity
kg_entity--EXPLICIT · require_dataset_readAUTHENTICATED_PUBLICsource
GET/v1/kg/stats
via gateway: /rag/v1/kg/stats
kg_stats--EXPLICIT · require_dataset_readAUTHENTICATED_PUBLICsource
POST/v1/query
via gateway: /rag/v1/query
query--EXPLICIT · require_dataset_readAUTHENTICATED_PUBLICsource
GET/v1/studies
via gateway: /rag/v1/studies
list_studies--EXPLICIT · require_dataset_readAUTHENTICATED_PUBLICsource

tes​

7 of 18 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
GET/api/runs
via gateway: /tes/api/runs
list_runs--EXPLICIT · require_permission(WORKFLOW_RUNS_READ)AUTHENTICATED_PUBLICsource
GET/api/runs/{run_id}
via gateway: /tes/api/runs/{run_id}
get_run--EXPLICIT · require_permission(WORKFLOW_RUNS_READ)AUTHENTICATED_PUBLICsource
POST/api/runs/{run_id}/cancel
via gateway: /tes/api/runs/{run_id}/cancel
cancel_run--EXPLICIT · require_permission(WORKFLOW_EXECUTE)AUTHENTICATED_PUBLICsource
GET/api/runs/{run_id}/logs
via gateway: /tes/api/runs/{run_id}/logs
get_logs--EXPLICIT · require_permission(WORKFLOW_RUNS_READ)AUTHENTICATED_PUBLICsource
GET/api/runs/{run_id}/results
via gateway: /tes/api/runs/{run_id}/results
get_results--EXPLICIT · require_permission(WORKFLOW_RUNS_READ)AUTHENTICATED_PUBLICsource
POST/api/runs/submit
via gateway: /tes/api/runs/submit
submit--EXPLICIT · require_permission(WORKFLOW_EXECUTE)AUTHENTICATED_PUBLICsource
POST/api/runs/validate
via gateway: /tes/api/runs/validate
validate--EXPLICIT · require_permission(WORKFLOW_EXECUTE)AUTHENTICATED_PUBLICsource

toolserver​

No routes of this service are itemised (8 found in source; see Services).

workflow-bundles​

7 of 10 routes itemised.

MethodPathHandlerTagsAuth status · evidenceVisibilitySource
GET/v1/categorieslist_categories--EXPLICIT · require_permission(workflow.read)AUTHENTICATED_PUBLICsource
GET/v1/runslist_runs--EXPLICIT · require_permission(runs.read)AUTHENTICATED_PUBLICsource
GET/v1/runs/{run_id}get_run--EXPLICIT · require_permission(runs.read)AUTHENTICATED_PUBLICsource
GET/v1/workflowslist_workflows--EXPLICIT · require_permission(workflow.read)AUTHENTICATED_PUBLICsource
GET/v1/workflows/{name}get_workflow_versions--EXPLICIT · require_permission(workflow.read)AUTHENTICATED_PUBLICsource
GET/v1/workflows/{workflow_id}/inputsget_workflow_inputs--EXPLICIT · require_permission(workflow.read)AUTHENTICATED_PUBLICsource
POST/v1/workflows/{workflow_id}/runrun_workflow--EXPLICIT · require_permission(workflow.execute)AUTHENTICATED_PUBLICsource