How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AGNTCY App Service API

AppService manages apps.

AGNTCY App Service API is one of 21 APIs that AGNTCY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include App Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and 2 JSON Schemas.

This API exposes 10 operations across 7 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version v1alpha1.

Requests are made against a single base URL, http://localhost:4000.

10 operations 7 paths 18 schemas 1 DELETE6 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1alpha1
Base URL
https://schema.oasf.outshift.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

AGNTCY App Service API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (AccessToken). An API key is passed in the header as x-id-api-key (ApiKey). By default, every request must be authenticated.

  • AccessToken — An IAM JWT token issued to a user during an OIDC flow.
  • ApiKey — An IAM Api key.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

AppService 10

AppService manages apps.

GET
/v1alpha1/apps
List Apps.
AppService_ListApps 6 params → 200default
POST
/v1alpha1/apps
Create a new App.
AppService_CreateApp body → 200default
GET
/v1alpha1/apps/all/count
Get apps count per type.
AppService_GetAppsCount → 200default
POST
/v1alpha1/apps/oasf
AppService_CreateOasfApp body → 200default
GET
/v1alpha1/apps/{appId}
Get App by id
AppService_GetApp 1 param → 200default
DELETE
/v1alpha1/apps/{appId}
Delete an existing App.
AppService_DeleteApp 1 param → 200default
PATCH
/v1alpha1/apps/{appId}
Update an App.
AppService_UpdateApp 1 param body → 200default
GET
/v1alpha1/apps/{appId}/api-key/refresh
Refresh the api-key for an App.
AppService_RefreshAppApiKey 1 param → 200default
GET
/v1alpha1/apps/{appId}/badge
Get the current badge issued for the App.
AppService_GetBadge 1 param → 200default
GET
/v1alpha1/tasks
Get the list of tasks of all apps
AppService_GetTasks 1 param → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are VerifiableCredential (10 properties), App (8 properties), Task (5 properties), CredentialStatus (4 properties). Each schema is shown below with its type and property counts.

Proof
object
A data integrity proof provides information about the proof mechanism, parameters required to verify that proof, and the proof value itself.
3 properties
GetAppsCountResponse
object
2 properties
GetTasksResponse_TaskList
object
1 property
Task
object
Identity Service Policy Task
5 properties
CredentialStatus
object
CredentialStatus represents the credentialStatus property of a Verifiable Credential. more information can be found [here] [here]: https://www.w3.org/TR/vc-dat…
4 properties
GetTasksResponse
object
1 property
Badge
object
2 properties
GoogleProtobufAny
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
CredentialSchema
object
CredentialSchema represents the credentialSchema property of a Verifiable Credential. more information can be found [here] [here]: https://www.w3.org/TR/vc-dat…
2 properties
AppTypeCountEntry
object
2 properties
CreateOasfAppRequest
object
1 property
PagedResponse
object
Pagination response
4 properties
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
CreateOasfAppResponse
object
2 properties
ListAppsResponse
object
2 properties
App
object
Identity Service App.
8 properties 2 required
BadgeClaims
object
BadgeClaims represents the content of a Badge VC defined [here] [here]: https://spec.identity.agntcy.org/docs/vc/intro/
2 properties
VerifiableCredential
object
DataModel represents the W3C Verifiable Credential Data Model defined [here] [here]: https://www.w3.org/TR/vc-data-model/
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

agntcy-appservice-api-openapi.yml Raw ↑

Other APIs AGNTCY publishes across the network.

Agent Directory (DIR)
AGNTCY Agents API
AGNTCY Auth Service API
AGNTCY Badge Service API
AGNTCY Classes and Objects API
AGNTCY Device Service API
AGNTCY ID Service API
AGNTCY Issuer Service API
AGNTCY JSON Schema API
AGNTCY Policy Service API
AGNTCY Sample Data API
AGNTCY Schema API
Where this information came from

This is an independent, third-party profile of AGNTCY App Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.