package kiapi.common

Get desktop application:
View/edit binary Protocol Buffers messages

The top-level envelope container for an API request (message from a client to the KiCad API server)

• optional ApiRequestHeader header = 1

• optional google.protobuf.Any message = 2

For future expansion: any header fields that should be sent with a request

Used in: ApiRequest

• string kicad_token = 1

  An opaque string identifying a running instance of KiCad. If this is set to a non-empty string in an API request, KiCad will reject the request if the value doesn't match its own token. This can be used to let API clients make sure they are still talking to the same instance of KiCad if they are long-running.

• string client_name = 2

  A string identifying an API client. Should be set by the client to a value that is unique to a specific instance of a client, for example the package name of the client plus its process ID or a random string, e.g. "com.github.me.my_awesome_plugin-73951". The main purpose of this name is to identify the client in debug logs.

• optional ApiResponseHeader header = 1

• optional ApiResponseStatus status = 2

• optional google.protobuf.Any message = 3

For future expansion: any header fields that should be sent with a response

Used in: ApiResponse

• string kicad_token = 1

  / An opaque string identifying a running instance of KiCad.

Used in: ApiResponse

• ApiStatusCode status = 1

  / A code describing the category of error (or AS_OK if no error)

• string error_message = 2

  / A human-readable description of the error, if any

Used in: ApiResponseStatus

• AS_UNKNOWN = 0

• AS_OK = 1

  Request succeeded

• AS_TIMEOUT = 2

  Request timed out

• AS_BAD_REQUEST = 3

  The request had invalid parameters or otherwise was illegal

• AS_NOT_READY = 4

  KiCad has recently started and cannot handle API requests yet

• AS_UNHANDLED = 5

  The request was not handled by KiCad

• AS_TOKEN_MISMATCH = 6

  The kicad_token in the request didn't match this KiCad's token

• AS_BUSY = 7

  KiCad is busy performing an operation and can't accept API commands

• AS_UNIMPLEMENTED = 8

  The requested API call has not yet been implemented