API Keys

Endpoint

Manajemen API key untuk akses programatik

List caller's API keys

GET

https://api-chat.bara.my.id

/api/api-keys

Mengembalikan API key milik agent yang sedang login.

List caller's API keys › Responses

Daftar API key

object[]

id

string · uuid · required

agent_id

string · uuid · required

name

string · required

key_type

string · enum · required

Enum values:

rest

webhook_signing

key_prefix

string · required

12 karakter pertama dari plaintext key (bukan rahasia)

scopes

required

JSON array of scope strings

is_active

boolean · required

created_at

string · date-time · required

last_used_at

string · date-time

expires_at

string · date-time

revoked_at

string · date-time

Create a new API key

POST

https://api-chat.bara.my.id

/api/api-keys

Memerlukan izin developer.access. Plaintext key hanya ditampilkan sekali, simpan dengan aman.

Create a new API key › Request Body

name

string · minLength: 1 · required

key_type

string · enum · required

Enum values:

rest

webhook_signing

expires_at

string · date-time

Tanggal kedaluwarsa opsional (UTC)

Create a new API key › Responses

API key berhasil dibuat (berisi plaintext key)

object · required

plaintext_key

string · required

Plaintext API key — hanya ditampilkan sekali saat pembuatan. Simpan dengan aman.

POST/api/api-keys

curl --request POST \
  --url https://api-chat.bara.my.id/api/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "key_type": "rest",
  "expires_at": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "name": "name",
  "key_type": "rest",
  "expires_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "key": {
    "id": "00000000-0000-0000-0000-000000000000",
    "agent_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "key_type": "rest",
    "key_prefix": "key_prefix",
    "scopes": {},
    "last_used_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "is_active": true,
    "created_at": "2024-08-25T15:00:00Z",
    "revoked_at": "2024-08-25T15:00:00Z"
  },
  "plaintext_key": "plaintext_key"
}

json

application/json

Revoke an API key

DELETE

https://api-chat.bara.my.id

/api/api-keys/{id}

Pemilik key dapat mencabut miliknya sendiri. Agent dengan izin agents.manage dapat mencabut key milik siapa pun.

Revoke an API key › path Parameters

id

string · uuid · required

Revoke an API key › Responses

API key berhasil dicabut

message

string

id

string · uuid

Roles Health

OmniStream CRM API

API Keys

Endpoint

Manajemen API key untuk akses programatik

List caller's API keys

GET

https://api-chat.bara.my.id

/api/api-keys

Mengembalikan API key milik agent yang sedang login.

List caller's API keys › Responses

Daftar API key

object[]

id

string · uuid · required

agent_id

string · uuid · required

name

string · required

key_type

string · enum · required

Enum values:

rest

webhook_signing

key_prefix

string · required

12 karakter pertama dari plaintext key (bukan rahasia)

scopes

required

JSON array of scope strings

is_active

boolean · required

created_at

string · date-time · required

last_used_at

string · date-time

expires_at

string · date-time

revoked_at

string · date-time

Create a new API key

POST

https://api-chat.bara.my.id

/api/api-keys

Memerlukan izin developer.access. Plaintext key hanya ditampilkan sekali, simpan dengan aman.

Create a new API key › Request Body

name

string · minLength: 1 · required

key_type

string · enum · required

Enum values:

rest

webhook_signing

expires_at

string · date-time

Tanggal kedaluwarsa opsional (UTC)

Create a new API key › Responses

API key berhasil dibuat (berisi plaintext key)

object · required

plaintext_key

string · required

Plaintext API key — hanya ditampilkan sekali saat pembuatan. Simpan dengan aman.

POST/api/api-keys

curl --request POST \
  --url https://api-chat.bara.my.id/api/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "key_type": "rest",
  "expires_at": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "name": "name",
  "key_type": "rest",
  "expires_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "key": {
    "id": "00000000-0000-0000-0000-000000000000",
    "agent_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "key_type": "rest",
    "key_prefix": "key_prefix",
    "scopes": {},
    "last_used_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "is_active": true,
    "created_at": "2024-08-25T15:00:00Z",
    "revoked_at": "2024-08-25T15:00:00Z"
  },
  "plaintext_key": "plaintext_key"
}

json

application/json

Revoke an API key

DELETE

https://api-chat.bara.my.id

/api/api-keys/{id}

Pemilik key dapat mencabut miliknya sendiri. Agent dengan izin agents.manage dapat mencabut key milik siapa pun.

Revoke an API key › path Parameters

id

string · uuid · required

Revoke an API key › Responses

API key berhasil dicabut

message

string

id

string · uuid

Roles Health