Get the Workspace
GET /v1/workspace
The user’s verified domain, when they have one; the Book asked for, named by Bkper, when the user can view it; and every App the user develops: managed ones are apps/{appId}, external ones are hosted elsewhere (repoUrl). The user’s own context is always user.
Authorizations
Parameters
Query Parameters
Responses
200
Success
The Workspace’s root, beside the user’s own context (user): the same tree as the agent’s sandbox and a local ~/.bkper (context) and the user’s Apps.
object
The user’s company: their verified domain, when they have one. Its context is domain, read by everyone in it.
object
Whether the user may change its context: the domain’s admin.
The Book asked for (bookId), when the user can view it: its context is books/{bookId}.
object
The Book’s name, from Bkper.
Whether the user may change its context: its editors and owner.
Every App the user develops (owner or developer), by name.
object
Managed: Bkper hosts its source, the repository apps/{appId}. external: hosted elsewhere, such as on GitHub; not a repository here.
External only: where its source is, an http(s) URL, when the App names one.
400
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
401
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
403
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
404
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
409
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
410
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
411
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
413
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
422
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
503
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.