ReferenceOrganizations
ResourcesOrganizations

Organizations

Create organization

POST
/api/v1/orgs/create

Authorization

ApiKey
Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/create" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List organizations

GET
/api/v1/orgs/list

Authorization

ApiKey
Authorization<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/list"
{  "count": 0,  "results": [    {      "user": "string",      "user_email": "string",      "name": "string",      "is_public": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "support_revoke_at": "2019-08-24T14:15:22Z",      "expiration": 0,      "role": "string",      "queue": "string",      "default_presets": [        "string"      ],      "default_presets_ordered": [        "string"      ],      "is_cloud_viewable": true,      "archived_deletion_interval": 0,      "auth": {},      "plan": {},      "usage": {}    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List organizations names

GET
/api/v1/orgs/names

Authorization

ApiKey
Authorization<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/names"
{  "count": 0,  "results": [    {      "user": "string",      "user_email": "string",      "name": "string",      "is_public": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "support_revoke_at": "2019-08-24T14:15:22Z",      "expiration": 0,      "role": "string",      "queue": "string",      "default_presets": [        "string"      ],      "default_presets_ordered": [        "string"      ],      "is_cloud_viewable": true,      "archived_deletion_interval": 0,      "auth": {},      "plan": {},      "usage": {}    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization

GET
/api/v1/orgs/{owner}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

usage?string

Owner usage query param.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string"
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch organization

PATCH
/api/v1/orgs/{owner}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete organization

DELETE
/api/v1/orgs/{owner}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

usage?string

Owner usage query param.

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update organization

PUT
/api/v1/orgs/{owner}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization activities

GET
/api/v1/orgs/{owner}/activities

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/activities"
{  "count": 0,  "results": [    {      "actor": "string",      "owner": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_action": "string",      "event_subject": "string",      "object_name": "string",      "object_uuid": "string",      "object_parent": "string"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization invitation details

GET
/api/v1/orgs/{owner}/invitations

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

member.user?string

User.

member.user_email?string

Read-only User email.

member.role?string

Role.

member.kind?string

Kind.

member.created_at?string

Optional time when the entity was created.

member.updated_at?string

Optional last time the entity was updated.

email?string

Optional email.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/invitations"
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Resend organization invitation

POST
/api/v1/orgs/{owner}/invitations

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

email?string

Optional email.

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/invitations" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch organization invitation

PATCH
/api/v1/orgs/{owner}/invitations

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

email?string

Optional email.

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/invitations" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete organization invitation details

DELETE
/api/v1/orgs/{owner}/invitations

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

member.user?string

User.

member.user_email?string

Read-only User email.

member.role?string

Role.

member.kind?string

Kind.

member.created_at?string

Optional time when the entity was created.

member.updated_at?string

Optional last time the entity was updated.

email?string

Optional email.

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/invitations"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update organization invitation

PUT
/api/v1/orgs/{owner}/invitations

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

email?string

Optional email.

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/invitations" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Organization license

POST
/api/v1/orgs/{owner}/license

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/license" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization members

GET
/api/v1/orgs/{owner}/members

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/members"
{  "count": 0,  "results": [    {      "user": "string",      "user_email": "string",      "role": "string",      "kind": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create organization member

POST
/api/v1/orgs/{owner}/members

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

email?string

Optional email.

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/members" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization member names

GET
/api/v1/orgs/{owner}/members/names

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/members/names"
{  "count": 0,  "results": [    {      "user": "string",      "user_email": "string",      "role": "string",      "kind": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch organization member

PATCH
/api/v1/orgs/{owner}/members/{member.user}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

member.user*string

User

Query Parameters

email?string

Optional email.

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/members/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update organization member

PUT
/api/v1/orgs/{owner}/members/{member.user}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

member.user*string

User

Query Parameters

email?string

Optional email.

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/members/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization member details

GET
/api/v1/orgs/{owner}/members/{name}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/members/string"
{  "user": "string",  "user_email": "string",  "role": "string",  "kind": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete organization member details

DELETE
/api/v1/orgs/{owner}/members/{name}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Component under namespace

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/members/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Organization plan

POST
/api/v1/orgs/{owner}/plan

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/plan" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get all runs in an organization

GET
/api/v1/orgs/{owner}/runs

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/runs"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "user": "string",      "owner": "string",      "project": "string",      "schedule_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "wait_time": 0.1,      "duration": 0.1,      "managed_by": "client",      "is_managed": true,      "is_approved": true,      "pending": "approval",      "content": "string",      "raw_content": "string",      "status": "created",      "bookmarked": true,      "live_state": 0,      "readme": "string",      "meta_info": {},      "kind": "job",      "runtime": "job",      "inputs": {},      "outputs": {},      "original": {        "uuid": "string",        "name": "string",        "kind": "copy"      },      "pipeline": {        "uuid": "string",        "name": "string",        "kind": "dag"      },      "status_conditions": [        {          "type": "created",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "role": "string",      "contributors": [        {}      ],      "settings": {        "namespace": "string",        "agent": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "queue": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "artifacts_store": {          "uuid": "string",          "name": "string",          "version": "string",          "url": "string"        },        "tensorboard": {},        "build": {},        "component": {},        "models": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ],        "artifacts": [          {            "owner": "string",            "project": "string",            "name": "string",            "state": "string"          }        ]      },      "resources": {        "cpu": 0.1,        "memory": 0.1,        "gpu": 0.1,        "custom": 0.1,        "cost": 0.1      },      "graph": {},      "merge": true    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Skip cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/Skip

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/Skip" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Approve cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/approve

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/approve" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Archive cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/archive

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/archive" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Bookmark cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/bookmark

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/bookmark" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete cross-project runs selection

DELETE
/api/v1/orgs/{owner}/runs/delete

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/runs/delete" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Invalidate cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/invalidate

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/invalidate" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get runs artifacts lineage

GET
/api/v1/orgs/{owner}/runs/lineage/artifacts

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

name?string

Entity managing the resource.

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/runs/lineage/artifacts"
{  "count": 0,  "results": [    {      "name": "string",      "state": "string",      "kind": "model",      "path": "string",      "connection": "string",      "run": "string",      "summary": {},      "is_input": true,      "meta_info": {}    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Restore cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/restore

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/restore" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Stop cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/stop

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Uuids of the entities

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/stop" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Tag cross-project runs selection

POST
/api/v1/orgs/{owner}/runs/tag

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/tag" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Transfer cross-project runs selection to a new project

POST
/api/v1/orgs/{owner}/runs/transfer

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/runs/transfer" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get a run in an organization

GET
/api/v1/orgs/{owner}/runs/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/runs/string"
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "user": "string",  "owner": "string",  "project": "string",  "schedule_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "wait_time": 0.1,  "duration": 0.1,  "managed_by": "client",  "is_managed": true,  "is_approved": true,  "pending": "approval",  "content": "string",  "raw_content": "string",  "status": "created",  "bookmarked": true,  "live_state": 0,  "readme": "string",  "meta_info": {},  "kind": "job",  "runtime": "job",  "inputs": {},  "outputs": {},  "original": {    "uuid": "string",    "name": "string",    "kind": "copy"  },  "pipeline": {    "uuid": "string",    "name": "string",    "kind": "dag"  },  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "role": "string",  "contributors": [    {}  ],  "settings": {    "namespace": "string",    "agent": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "queue": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "artifacts_store": {      "uuid": "string",      "name": "string",      "version": "string",      "url": "string"    },    "tensorboard": {},    "build": {},    "component": {},    "models": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ],    "artifacts": [      {        "owner": "string",        "project": "string",        "name": "string",        "state": "string"      }    ]  },  "resources": {    "cpu": 0.1,    "memory": 0.1,    "gpu": 0.1,    "custom": 0.1,    "cost": 0.1  },  "graph": {},  "merge": true}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization settings

GET
/api/v1/orgs/{owner}/settings

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

organization.user?string

User.

organization.user_email?string

Read-only User email.

organization.name?string

Name.

organization.is_public?boolean

Optional flag to tell if this organization is public.

organization.created_at?string

Optional time when the entity was created.

organization.updated_at?string

Optional last time the entity was updated.

organization.support_revoke_at?string

Optional time to revoke support access.

organization.expiration?integer

Optional expiration for support.

organization.role?string

Current user's role in this org.

organization.queue?string

Default queue.

organization.default_presets?array<string>

Default presets.

organization.default_presets_ordered?array<string>

Default presets ordered.

organization.is_cloud_viewable?boolean

Setting to enable viewable metadata on cloud.

organization.archived_deletion_interval?integer

Setting to configure default archived deletion interval.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/settings"
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch oranization settings

PATCH
/api/v1/orgs/{owner}/settings

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update organization settings

PUT
/api/v1/orgs/{owner}/settings

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Organization body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "user": "string",  "user_email": "string",  "name": "string",  "is_public": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "support_revoke_at": "2019-08-24T14:15:22Z",  "expiration": 0,  "role": "string",  "queue": "string",  "default_presets": [    "string"  ],  "default_presets_ordered": [    "string"  ],  "is_cloud_viewable": true,  "archived_deletion_interval": 0,  "auth": {},  "plan": {},  "usage": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get organization stats

GET
/api/v1/orgs/{owner}/stats

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Stats Mode.

kind?string

Stats Kind.

aggregate?string

Stats aggregate.

groupby?string

Stats group.

trunc?string

Stats trunc.

start_date?string

Stats start date.

end_date?string

Stats end date.

boundary?boolean

Stats boundary.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/stats"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get all runs in an organization

GET
/api/v1/orgs/{owner}/versions/{kind}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

kind*string

Version Kind

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/versions/string"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "owner": "string",      "user": "string",      "project": "string",      "connection": "string",      "run": "string",      "artifacts": [        "string"      ],      "meta_info": {},      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "stage": "testing",      "kind": "component",      "stage_conditions": [        {          "type": "testing",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "content": "string",      "readme": "string",      "state": "string",      "role": "string",      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get multi runs events

GET
/streams/v1/{namespace}/orgs/{owner}/runs/multi/events/{kind}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

kind*string

The artifact kind

Query Parameters

entity?string

Entity where the run will be assigned.

names?string

Names query param.

runs?string

Runs query param.

orient?string

Orient query param.

force?boolean

Force query param.

sample?integer

Sample query param.

connection?string

Connection to use.

status?string

Optional status.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/streams/v1/string/orgs/string/runs/multi/events/model"
{  "data": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get multi run importance

POST
/streams/v1/{namespace}/orgs/{owner}/runs/multi/importance

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

Query Parameters

entity?string

Entity where the run will be assigned.

Request Body

application/json

Params/Metrics data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/streams/v1/string/orgs/string/runs/multi/importance" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Versions
Agents

On this page

Create organizationList organizationsList organizations namesGet organizationPatch organizationDelete organizationUpdate organizationGet organization activitiesGet organization invitation detailsResend organization invitationPatch organization invitationDelete organization invitation detailsUpdate organization invitationOrganization licenseGet organization membersCreate organization memberGet organization member namesPatch organization memberUpdate organization memberGet organization member detailsDelete organization member detailsOrganization planGet all runs in an organizationSkip cross-project runs selectionApprove cross-project runs selectionArchive cross-project runs selectionBookmark cross-project runs selectionDelete cross-project runs selectionInvalidate cross-project runs selectionGet runs artifacts lineageRestore cross-project runs selectionStop cross-project runs selectionTag cross-project runs selectionTransfer cross-project runs selection to a new projectGet a run in an organizationGet organization settingsPatch oranization settingsUpdate organization settingsGet organization statsGet all runs in an organizationGet multi runs eventsGet multi run importance

Actions

Give us feedback