Projects

Projects

High-level operations on projects, like import and backup.

Projects Endpoints

Import API definition to a new project

Imports a Swagger/OpenAPI definition from a URL or a base64-encoded file into a new project. This is an asynchronous operation.

Query Parameters
  • action
    const:
    import
    required

    The action to perform.

Body
application/json

The API definition and new project details.

Defines the source and destination for an API spec import to a new project.

importFormat
const:
AutoDocs
required

The import format.

newProjectId
string

The ID for the new project. Either this or newProjectName must be provided.

newProjectName
string

The name for the new project. Either this or newProjectId must be provided.

newProjectLanguageFourLetterCode
string
default:
en-US

The language code for the new project, e.g., 'en-US'.

Responses
POST/projects
curl https://your-portal.clickhelp.co/api/v1/projects \
  --request POST \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "importFormat": "AutoDocs",
  "newProjectId": "",
  "newProjectName": "",
  "newProjectLanguageFourLetterCode": "en-US",
  "inputFileUrl": "",
  "options": {
    "__type": "AutoDocsImportOptions",
    "splitModeType": "GroupMethods",
    "updatedMountPointTocNodeId": ""
  }
}'

{
  "taskKey": "…"
}

The import task has been accepted. Use the returned taskKey to check the status.

Get a project or publication by ID

Returns information about a single project or publication. The parentId field will be null for projects and will contain the project ID for publications.

Path Parameters
  • publicationId
    string
    required

    The ID of the project or publication.

Responses
GET/projects/{publicationId}
curl https://your-portal.clickhelp.co/api/v1/projects/ \
  --header 'Authorization: Basic username:password'

{
  "id": "…",
  "title": "…",
  "createdOn": "2026-01-23T22:10:04.180Z",
  "visibility": "Private",
  "parentId": "…",
  "fullUrl": "https://example.com",
  "url": "…",
  "parentUrl": "…"
}

Successful operation.

Create a project backup or export a publication

Performs an action on a project or publication, like creating a backup or exporting. The exact behavior is determined by the 'action' query parameter.

Path Parameters
  • publicationId
    string
    required

    The ID of the project or publication.

Query Parameters
  • action
    string enum
    required

    The action to perform.

    • download
    • export
    • publish
    • import
Body
application/json

The request body, dependent on the action.

oneOf

The properties for an export request.

Schema for creating a new publication.

The properties to update for a publication.

Defines the source for an API spec import to an existing project.

Responses
POST/projects/{publicationId}
curl https://your-portal.clickhelp.co/api/v1/projects/ \
  --request POST \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "outputFileName": ""
}'

{
  "taskKey": "…"
}

The task has been accepted. Use the returned taskKey to check the status.