Get a repository
GET /v1/workspace/apps/{appId}
Its working copy’s files and marks, and whether the user may change and save it; cloned into the sandbox when it is not there yet. For the App’s owner and developers (403 workspace_forbidden), when Bkper hosts its source: its folder in /workspace/apps. Saving never deploys.
Authorizations
Parameters
Path Parameters
Responses
200
Success
A repository’s working copy in the workspace’s sandbox: the files the agent works on, with the user’s changes, saved or not. Opening one the sandbox does not have yet clones it there.
object
Which: user, domain, books/{bookId} or apps/{appId}.
Git’s tree id of the working copy, untracked files included, ignored ones left out: it changes whenever its files do, so an unchanged one needs nothing read again. Save takes the review’s.
The files that differ from the base, committed or not, by path: what Save would publish.
object
Files the base does not have.
Files that differ from the base.
Files of the base no longer there.
An App’s: its folder in the sandbox, /workspace/apps/{folder}.
An App’s: the name in its bkper.yaml.
Whether the user may change and save it: their own context always; their domain’s, its admin; a Book’s, its editors and owner; an App’s source, its owner and developers. Elsewhere it only reads.
Its files in the working copy, text or not, by path, ignored ones left out. Text files open and save; PNG and JPEG pictures show through /image; others are only listed.
Agent context: its skills, as agents load them. Empty for App source.
object
Its SKILL.md.
Agent context: what agents skip or cut, such as an invalid skill: data for the person, never instructions.
object
The file or folder it concerns.
More than the 500 files listed.
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.