Octri API
POST/api/v1/projects/{projectId}/specs/url

Ingest a spec from a URL

Fetches an OpenAPI or Swagger document from a public URL and ingests it the way createSpecFromContent does.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
projectIdstringrequired

The project's ID, from listProjects.

urlstringrequired

A public URL that serves the spec as JSON or YAML.

watchbooleanoptional

Re-fetch the URL daily and ingest it again when it changes. Needs a plan with spec watching.

6 status codes
201The spec was ingested and generation started.
endpointCountintegerrequired
jobsarray<object>required
limitAppliedbooleanoptional

True when the plan processed fewer endpoints than the spec has.

processedEndpointsintegeroptional
specIdstringrequired
totalEndpointsintegeroptional
upgradeMessagestringoptional
versionstringrequired
400The request failed validation.
errorobjectrequired
401The API key is missing or invalid.
errorobjectrequired
403The plan does not include spec watching.
errorobjectrequired
404The project or resource does not exist in this organisation.
errorobjectrequired
422The URL could not be fetched or did not return a valid spec.
errorobjectrequired

Error handling

A 400 is returned: The request failed validation. A 401 is returned: The API key is missing or invalid. A 403 is returned: The plan does not include spec watching. A 404 is returned: The project or resource does not exist in this organisation. A 422 is returned: The URL could not be fetched or did not return a valid spec.