API docs by Redocly

Orion Public API (0.1.0)

Download OpenAPI specification:

Public API for Orion.

authentication

Login

Request Body schema: application/x-www-form-urlencoded
required
Grant Type (string) or Grant Type (null) (Grant Type)
username
required
string (Username)
password
required
string (Password)
scope
string (Scope)
Default: ""
Client Id (string) or Client Id (null) (Client Id)
Client Secret (string) or Client Secret (null) (Client Secret)

Responses

Response samples

Content type
application/json
null

Token Authentication

Request Body schema: application/x-www-form-urlencoded
required
Grant Type (string) or Grant Type (null) (Grant Type)
username
required
string (Username)
password
required
string (Password)
scope
string (Scope)
Default: ""
Client Id (string) or Client Id (null) (Client Id)
Client Secret (string) or Client Secret (null) (Client Secret)

Responses

Response samples

Content type
application/json
null

jobs

Create Job

Create a new job from a payload and return the assignment ID

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
required
any (Payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get All Assign Templates

Get all assignment templates for the current user.

Authorizations:
OAuth2PasswordBearer
query Parameters
User Id (string) or User Id (null) (User Id)

User ID to filter templates

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Start Job

Create a new job from a payload and return the assignment ID

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
required
any (Payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get Insight Status

Get status of a job. If the job is complete, link to an insight if possible

Authorizations:
OAuth2PasswordBearer
query Parameters
assignment_id
required
string <uuid> (Assignment Id)

Responses

Response samples

Content type
application/json
{
  • "job_status": "draft",
  • "insight_id": "033a60fb-2726-4853-9672-f32ae1fca2bc"
}

Get Insight Result

Get insight result as markdown

Authorizations:
OAuth2PasswordBearer
query Parameters
insight_id
required
string <uuid> (Insight Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

webhooks

List Webhooks

List all webhooks

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Webhook

Create a new webhook

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
url
required
string (Url)
headers
Array of any (Headers)
Default: []
user_id
required
string <uuid> (User Id)
presence_name
required
string (Presence Name)

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "headers": [ ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "presence_name": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get Webhook By Id

Retrieve a specific webhook by ID

Authorizations:
OAuth2PasswordBearer
path Parameters
webhook_id
required
string <uuid> (Webhook Id)

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "headers": [ ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "presence_name": "string"
}

Update Webhook

Update a specific webhook by ID

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
id
required
string <uuid> (Id)
Url (string) or Url (null) (Url)
Array of Headers (any) or Headers (null) (Headers)
User Id (string) or User Id (null) (User Id)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "headers": [
    ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "headers": [ ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "presence_name": "string"
}

Delete Webhook

Delete a specific webhook by ID

Authorizations:
OAuth2PasswordBearer
path Parameters
webhook_id
required
string <uuid> (Webhook Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}