Skip to content
Norbelys
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a workspace.

Only the credential’s own workspace exists for it; any other id is not found.

GET/v1/workspaces/{id}
Authorization
AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Path parameters
idId_Workspacerequired

The workspace id (ws_…).

matches ^ws_[0-9a-f]{32}$
Responses
200

The workspace.

created_atTimestamprequired
deletion_requested_atTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
idId_Workspacerequired
matches ^ws_[0-9a-f]{32}$
modeWorkspaceModerequired

A workspace's mode, which its keys share: live reaches providers, test sends through a fake transport only.

Allowed:livetest
namestringrequired
settingsanyrequired

The workspace's settings (settings.ai: the AI switches and budget).

slugstringrequired
timezonestringrequired

The IANA time zone of the workspace's dates.

updated_atTimestamprequired
usageWorkspaceUsage | null
Show properties
One of:
WorkspaceUsage
aiAiSpendrequired

The month's AI spend, in micro-dollars (millionths of a US dollar).

Show properties
budget_microsinteger<int64>required

The month's budget: no call starts that could take spend and reservations past it.

reserved_microsinteger<int64>required

The bounds of the calls still running.

spent_microsinteger<int64>required

What settled calls cost.

computed_atTimestamprequired

When these figures were read.

connectionsMeteredrequired

A count and the limit it is held to; limit is null when nothing limits it.

Show properties
limitinteger<int64> | null
usedinteger<int64>required
monthDaterequired

The month counted, as its first day (UTC).

peopleMeteredrequired

A count and the limit it is held to; limit is null when nothing limits it.

Show properties
limitinteger<int64> | null
usedinteger<int64>required
sendsMeteredrequired

A count and the limit it is held to; limit is null when nothing limits it.

Show properties
limitinteger<int64> | null
usedinteger<int64>required
null
null
versioninteger<int64>required

The version If-Match names.

401

No valid credential.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

Allowed:invalid_requestunauthorizedforbiddensession_requirednot_foundarchivedmethod_not_allowedconflictinvalid_stateidempotency_in_progressprecondition_failedpayload_too_largeunsupported_media_typevalidation_failedidempotency_mismatchsuppressedcaptcha_failedinsufficient_scoperate_limitedquota_exceededinternal_errorservice_unavailabletimeout
detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks workspace:read.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

Allowed:invalid_requestunauthorizedforbiddensession_requirednot_foundarchivedmethod_not_allowedconflictinvalid_stateidempotency_in_progressprecondition_failedpayload_too_largeunsupported_media_typevalidation_failedidempotency_mismatchsuppressedcaptcha_failedinsufficient_scoperate_limitedquota_exceededinternal_errorservice_unavailabletimeout
detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

404

No such workspace for this credential.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

Allowed:invalid_requestunauthorizedforbiddensession_requirednot_foundarchivedmethod_not_allowedconflictinvalid_stateidempotency_in_progressprecondition_failedpayload_too_largeunsupported_media_typevalidation_failedidempotency_mismatchsuppressedcaptcha_failedinsufficient_scoperate_limitedquota_exceededinternal_errorservice_unavailabletimeout
detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.norbelys.com/v1/workspaces/ws_0190f8a2b4c87a10b6d2e4f6a8c0e2f4' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "created_at": "2019-08-24T14:15:22Z",
  "deletion_requested_at": "2019-08-24T14:15:22Z",
  "id": "ws_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "mode": "live",
  "name": "string",
  "settings": null,
  "slug": "string",
  "timezone": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "usage": {
    "ai": {
      "budget_micros": 0,
      "reserved_micros": 0,
      "spent_micros": 0
    },
    "computed_at": "2019-08-24T14:15:22Z",
    "connections": {
      "limit": 0,
      "used": 0
    },
    "month": "2019-08-24",
    "people": {
      "limit": 0,
      "used": 0
    },
    "sends": {
      "limit": 0,
      "used": 0
    }
  },
  "version": 0
}