Version 2.20 has reached end of support. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Applications

Get a list of users applications.

get

Retrieve a list of the users applications.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json
namestringRequired
clientIdstringRequired
idstringRequired
createdAtstring · date-time · nullableRequired
lastLoginstring · date-time · nullableRequired
get/api/v1/user-applications
GET /api/v1/user-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "my-user-app",
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "clientId": "3434c-12323ab-4ce2ea6",
    "createdAt": "2019-01-01T00:00:00Z",
    "lastLogin": "2020-01-01T00:00:00Z"
  }
]

Create a user application.

post

Used to create a user application.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestringRequired

The name of the user application. The name must be unique within the user's applications list and can only contain lowercase alphanumeric characters and hyphens. It must start and end with a letter.

Pattern: ^[a-z][-_a-z0-9]*[a-z0-9]$
Responses
201

Executed successfully.

application/json
idstringRequired
clientIdstringRequired
namestringRequired
secretstringRequired
post/api/v1/user-applications
POST /api/v1/user-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "app-name"
}
{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "clientId": "5e7b3b7b4b7b4b7b",
  "name": "app123",
  "secret": "this-is-the-app-secret"
}

Get user application by id.

get

Retrieve the details of a user's application by app id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
200

Executed successfully.

application/json
namestringRequired
clientIdstringRequired
idstringRequired
createdAtstring · date-time · nullableRequired
lastLoginstring · date-time · nullableRequired
get/api/v1/user-applications/{appId}
GET /api/v1/user-applications/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "my-user-app",
  "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  "clientId": "3434c-12323ab-4ce2ea6",
  "createdAt": "2019-01-01T00:00:00Z",
  "lastLogin": "2020-01-01T00:00:00Z"
}

Delete a user application byid.

delete

Use to user a user application by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
204

Executed successfully.

No content
delete/api/v1/user-applications/{appId}
DELETE /api/v1/user-applications/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Regenerate a user application secret.

post

Use to regenerate the user application secret by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
200

Regenerated successfully.

application/json
secretstringOptional
post/api/v1/user-applications/{appId}/secret
POST /api/v1/user-applications/{appId}/secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "secret": "this-is-my-secret"
}

Get a list of all users applications.

get

Retrieve a list of all users applications.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
clientIdstringOptional

Filter results by clientId

Example: 3434c-12323ab-4ce2ea6-b44fc-db344d
createdBystringOptional

Filter results by creatdBy

Example: test@run.ai
Responses
200

Executed successfully.

application/json
namestringRequired
idstringRequired
clientIdstringRequired
createdBystringRequired
createdAtstring · date-time · nullableRequired
lastLoginstring · date-time · nullableRequired
get/api/v1/administration/user-applications
GET /api/v1/administration/user-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "my-user-app",
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "clientId": "1434c-123233ab-4ce2ea6-b44fc-db344d",
    "createdBy": "test@run.ai",
    "createdAt": "2020-01-01T00:00:00Z",
    "lastLogin": "2020-01-01T00:00:00Z"
  }
]

Delete a user application by id for adminstrations.

delete

Use to delete a user application by id for adminstrations.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
204

Executed successfully.

No content
delete/api/v1/administration/user-applications/{appId}
DELETE /api/v1/administration/user-applications/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousUsers
NextAuditLogs

Last updated