Connect JSON RPC reference
Availability: The DevBase runtime and production API are not yet deployed. This page and its examples describe the committed v1 contract for integration planning; requests to the API URL will not succeed until the runtime is released.
This reference is generated from the committed devbase.v1 descriptor and method-policy inventory. It contains only RPCs available to server-side API keys. In the downloadable connect.json, top-level methods use the production baseUrl. Non-production fixtures are grouped under testEnvironment.methods; resolve testEnvironment.baseUrlEnvironmentVariable from your test configuration and never inherit the production base URL. Replace ${BASE64_SECRET_VALUE} in secret examples with a securely generated value before sending a request.
/devbase.v1.ArtifactService/CompleteArtifactUpload
- Request:
devbase.v1.CompleteArtifactUploadRequest - Response:
devbase.v1.CompleteArtifactUploadResponse - API-key scopes:
artifacts:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.ArtifactService/CreateArtifactDownload
- Request:
devbase.v1.CreateArtifactDownloadRequest - Response:
devbase.v1.CreateArtifactDownloadResponse - API-key scopes:
artifacts:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.ArtifactService/CreateArtifactUpload
- Request:
devbase.v1.CreateArtifactUploadRequest - Response:
devbase.v1.CreateArtifactUploadResponse - API-key scopes:
artifacts:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.ArtifactService/DeleteArtifact
- Request:
devbase.v1.DeleteArtifactRequest - Response:
devbase.v1.DeleteArtifactResponse - API-key scopes:
artifacts:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.ArtifactService/GetArtifact
- Request:
devbase.v1.GetArtifactRequest - Response:
devbase.v1.GetArtifactResponse - API-key scopes:
artifacts:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.ArtifactService/ListArtifacts
- Request:
devbase.v1.ListArtifactsRequest - Response:
devbase.v1.ListArtifactsResponse - API-key scopes:
artifacts:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.CatalogService/GetMiniApp
- Request:
devbase.v1.GetMiniAppRequest - Response:
devbase.v1.GetMiniAppResponse - API-key scopes:
catalog:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.CatalogService/ListMiniApps
- Request:
devbase.v1.ListMiniAppsRequest - Response:
devbase.v1.ListMiniAppsResponse - API-key scopes:
catalog:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.JobService/CancelJob
- Request:
devbase.v1.CancelJobRequest - Response:
devbase.v1.CancelJobResponse - API-key scopes:
jobs:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.JobService/DeleteJob
- Request:
devbase.v1.DeleteJobRequest - Response:
devbase.v1.DeleteJobResponse - API-key scopes:
jobs:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.JobService/GetJob
- Request:
devbase.v1.GetJobRequest - Response:
devbase.v1.GetJobResponse - API-key scopes:
jobs:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.JobService/ListJobs
- Request:
devbase.v1.ListJobsRequest - Response:
devbase.v1.ListJobsResponse - API-key scopes:
jobs:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.JobService/WatchJob
- Request:
devbase.v1.WatchJobRequest - Response:
devbase.v1.WatchJobResponse - API-key scopes:
jobs:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: Connect server-streaming with length-prefixed JSON envelopes.
The response is written as Connect JSON envelopes to watchjob.connect; decode its five-byte envelopes with a Connect-capable client.
/devbase.v1.PublicTestFixtureService/RunAsync
Non-production only. This fixture is registered only with ENABLE_TEST_FIXTURE=true in a test environment. Use your configured test API base URL.
- Request:
devbase.v1.RunAsyncRequest - Response:
devbase.v1.RunAsyncResponse - API-key scopes:
test-fixture:execute - Billing:
metered - Execution:
asynchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.PublicTestFixtureService/RunStream
Non-production only. This fixture is registered only with ENABLE_TEST_FIXTURE=true in a test environment. Use your configured test API base URL.
- Request:
devbase.v1.RunStreamRequest - Response:
devbase.v1.RunStreamResponse - API-key scopes:
test-fixture:execute - Billing:
metered - Execution:
synchronous
JSON fields
Request
Response
- Streaming: Connect server-streaming with length-prefixed JSON envelopes.
The response is written as Connect JSON envelopes to watchjob.connect; decode its five-byte envelopes with a Connect-capable client.
/devbase.v1.PublicTestFixtureService/RunSync
Non-production only. This fixture is registered only with ENABLE_TEST_FIXTURE=true in a test environment. Use your configured test API base URL.
- Request:
devbase.v1.RunSyncRequest - Response:
devbase.v1.RunSyncResponse - API-key scopes:
test-fixture:execute - Billing:
metered - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.SecretService/CreateSecret
- Request:
devbase.v1.CreateSecretRequest - Response:
devbase.v1.CreateSecretResponse - API-key scopes:
secrets:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.SecretService/DeleteSecret
- Request:
devbase.v1.DeleteSecretRequest - Response:
devbase.v1.DeleteSecretResponse - API-key scopes:
secrets:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.SecretService/GetSecret
- Request:
devbase.v1.GetSecretRequest - Response:
devbase.v1.GetSecretResponse - API-key scopes:
secrets:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.SecretService/ListSecrets
- Request:
devbase.v1.ListSecretsRequest - Response:
devbase.v1.ListSecretsResponse - API-key scopes:
secrets:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.SecretService/RotateSecret
- Request:
devbase.v1.RotateSecretRequest - Response:
devbase.v1.RotateSecretResponse - API-key scopes:
secrets:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/CreateWebhookEndpoint
- Request:
devbase.v1.CreateWebhookEndpointRequest - Response:
devbase.v1.CreateWebhookEndpointResponse - API-key scopes:
webhooks:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/DeleteWebhookEndpoint
- Request:
devbase.v1.DeleteWebhookEndpointRequest - Response:
devbase.v1.DeleteWebhookEndpointResponse - API-key scopes:
webhooks:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/GetWebhookEndpoint
- Request:
devbase.v1.GetWebhookEndpointRequest - Response:
devbase.v1.GetWebhookEndpointResponse - API-key scopes:
webhooks:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/ListWebhookDeliveries
- Request:
devbase.v1.ListWebhookDeliveriesRequest - Response:
devbase.v1.ListWebhookDeliveriesResponse - API-key scopes:
webhooks:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/ListWebhookEndpoints
- Request:
devbase.v1.ListWebhookEndpointsRequest - Response:
devbase.v1.ListWebhookEndpointsResponse - API-key scopes:
webhooks:read - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/RedeliverWebhookDelivery
- Request:
devbase.v1.RedeliverWebhookDeliveryRequest - Response:
devbase.v1.RedeliverWebhookDeliveryResponse - API-key scopes:
webhooks:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/RotateWebhookSecret
- Request:
devbase.v1.RotateWebhookSecretRequest - Response:
devbase.v1.RotateWebhookSecretResponse - API-key scopes:
webhooks:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
/devbase.v1.WebhookService/UpdateWebhookEndpoint
- Request:
devbase.v1.UpdateWebhookEndpointRequest - Response:
devbase.v1.UpdateWebhookEndpointResponse - API-key scopes:
webhooks:write - Billing:
free - Execution:
synchronous
JSON fields
Request
Response
- Streaming: unary JSON request and response.
Referenced message and enum schemas
devbase.v1.Artifact
devbase.v1.ArtifactConstraints
devbase.v1.ErrorDetail
devbase.v1.FieldViolation
devbase.v1.Job
devbase.v1.JobHeartbeat
devbase.v1.MiniAppDescriptor
devbase.v1.MiniAppOperation
devbase.v1.PageInfo
devbase.v1.PageRequest
devbase.v1.Secret
devbase.v1.UUIDv7
devbase.v1.WebhookDelivery
devbase.v1.WebhookEndpoint
google.protobuf.Duration
google.protobuf.Timestamp
devbase.v1.ArtifactState enum values
ARTIFACT_STATE_UNSPECIFIEDARTIFACT_STATE_PENDING_UPLOADARTIFACT_STATE_AVAILABLEARTIFACT_STATE_DELETEDARTIFACT_STATE_EXPIRED
devbase.v1.ErrorReason enum values
ERROR_REASON_UNSPECIFIEDERROR_REASON_INVALID_ARGUMENTERROR_REASON_AUTHENTICATION_REQUIREDERROR_REASON_AUTHORIZATION_DENIEDERROR_REASON_RESOURCE_NOT_FOUNDERROR_REASON_IDEMPOTENCY_CONFLICTERROR_REASON_RESOURCE_VERSION_CONFLICTERROR_REASON_FAILED_PRECONDITIONERROR_REASON_QUOTA_EXHAUSTEDERROR_REASON_RATE_LIMITEDERROR_REASON_CONCURRENCY_EXHAUSTEDERROR_REASON_BILLING_BLOCKEDERROR_REASON_CHECKSUM_MISMATCHERROR_REASON_DEPENDENCY_UNAVAILABLEERROR_REASON_INTERNAL
devbase.v1.ExecutionMode enum values
EXECUTION_MODE_UNSPECIFIEDEXECUTION_MODE_SYNCHRONOUSEXECUTION_MODE_ASYNCHRONOUS
devbase.v1.JobState enum values
JOB_STATE_UNSPECIFIEDJOB_STATE_QUEUEDJOB_STATE_RUNNINGJOB_STATE_CANCELINGJOB_STATE_SUCCEEDEDJOB_STATE_FAILEDJOB_STATE_CANCELED
devbase.v1.RetryGuidance enum values
RETRY_GUIDANCE_UNSPECIFIEDRETRY_GUIDANCE_AFTER_DELAYRETRY_GUIDANCE_AFTER_DEPENDENCY_RECOVERYRETRY_GUIDANCE_AFTER_REAUTHENTICATIONRETRY_GUIDANCE_AFTER_STATE_CHANGERETRY_GUIDANCE_DO_NOT_RETRY
devbase.v1.WebhookDeliveryState enum values
WEBHOOK_DELIVERY_STATE_UNSPECIFIEDWEBHOOK_DELIVERY_STATE_PENDINGWEBHOOK_DELIVERY_STATE_DELIVEREDWEBHOOK_DELIVERY_STATE_FAILEDWEBHOOK_DELIVERY_STATE_CANCELED