Create Command

curl --request POST \ --url https://analyst.heyhumm.ai/commands \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "content": "<string>", "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "description": "<string>" } '

{ "name": "<string>", "content": "<string>", "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "description": "<string>", "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "usage_count": 0, "current_version": 1, "generation_status": "ready", "generation_error": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create command model.

name

string

required

Command name (alphanumeric + hyphens/underscores)

content

string

required

Command content as markdown text

organization_id

string<uuid>

required

Organization ID

description

string | null

Single sentence description of the command

Response

Successful Response

Response model for command.

name

string

required

Command name (alphanumeric + hyphens/underscores)

content

string

required

Command content as markdown text

organization_id

string<uuid>

required

Organization ID

string<uuid>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

Single sentence description of the command

created_by_user_id

string<uuid> | null

usage_count

integer

default:0

current_version

integer

default:1

generation_status

enum<string>

default:ready

Status of LLM-based command generation.

Available options:

ready,

generating,

failed

generation_error

string | null