Octri API
POST/api/v1/projects

Create a project

Creates an empty project and allocates its docs hostname. Push a spec with createSpecFromContent or createSpecFromUrl to generate its docs.

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

2 body fields
namestringrequired

Display name of the project.

slugstringoptional

Unique within the organisation. Derived from name when omitted.

5 status codes
201The project was created.
projectobjectrequired

The stored project. It also carries settings not listed here.

400The request failed validation.
errorobjectrequired
401The API key is missing or invalid.
errorobjectrequired
402The plan's project limit has been reached.
errorobjectrequired
409Another project in this organisation already has this slug.
errorobjectrequired

Error handling

A 400 is returned: The request failed validation. A 401 is returned: The API key is missing or invalid. A 402 is returned: The plan's project limit has been reached. A 409 is returned: Another project in this organisation already has this slug.