Authentication
HTTP Authentication
bearer
Openpm API Key Authentication
Packages
get/packages
Returns all packages
Path parameters
- Name
limit- Type
- integer
- Description
How many package to return per page (default 500)
- Name
page- Type
- integer
- Description
Page number (default 1)
Response
JSON
{
"items": [
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string"
}
],
"total": 0,
"page": 0,
"limit": 0
}post/packages
Creates a package
Body params
- Name
id- Type
- string
- Required
- Description
- Package id
- Name
name- Type
- string
- Description
- Package name
- Name
machine_name- Type
- string
- Description
- Package name (for machines)
- Name
domain- Type
- string
- Description
- Package domain
- Name
version- Type
- string
- Description
- Package version
- Name
created_at- Type
- string
- Description
- Package creation date
- Name
updated_at- Type
- string
- Description
- Package last update date
- Name
published_at- Type
- string
- Description
- Package publication date
- Name
logo_url- Type
- string
- Description
- Package logo url
- Name
contact_email- Type
- string
- Description
- Package contact email
- Name
legal_info_url- Type
- string
- Description
- Package legal info url
- Name
description- Type
- string
- Description
- Package description
- Name
machine_description- Type
- string
- Description
- Package description (for machines)
- Name
user_id- Type
- string
- Description
- Package owner user id
- Name
openapi- Type
- string
- Description
- Package OpenAPI specification
Response
JSON
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string",
"openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}get/packages/search
Searches packages
Path parameters
- Name
limit- Type
- integer
- Description
How many package to return per page (default 500)
- Name
page- Type
- integer
- Description
Page number (default 1)
- Name
query- Type
- string
- Required
- Description
Search query
Response
JSON
{
"items": [
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string"
}
],
"total": 0,
"page": 0,
"limit": 0
}get/packages/lookup
Looks up packages by id
Path parameters
- Name
ids- Type
- string
- Description
CSV list of package ids
Response
JSON
[
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string",
"openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}
]get/packages/connected
Looks up packages that are connected to the current user
Response
JSON
[
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string",
"openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}
]get/packages/{packageId}
Returns a package
Path parameters
- Name
packageId- Type
- string
- Required
- Description
Package id
Response
JSON
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string",
"openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}post/packages/{packageId}
Updates a package
Path parameters
- Name
packageId- Type
- string
- Required
- Description
Package id
Body params
- Name
id- Type
- string
- Required
- Description
- Package id
- Name
name- Type
- string
- Description
- Package name
- Name
machine_name- Type
- string
- Description
- Package name (for machines)
- Name
domain- Type
- string
- Description
- Package domain
- Name
version- Type
- string
- Description
- Package version
- Name
created_at- Type
- string
- Description
- Package creation date
- Name
updated_at- Type
- string
- Description
- Package last update date
- Name
published_at- Type
- string
- Description
- Package publication date
- Name
logo_url- Type
- string
- Description
- Package logo url
- Name
contact_email- Type
- string
- Description
- Package contact email
- Name
legal_info_url- Type
- string
- Description
- Package legal info url
- Name
description- Type
- string
- Description
- Package description
- Name
machine_description- Type
- string
- Description
- Package description (for machines)
- Name
user_id- Type
- string
- Description
- Package owner user id
- Name
openapi- Type
- string
- Description
- Package OpenAPI specification
Response
JSON
{
"id": "string",
"name": "Acme",
"machine_name": "acme",
"domain": "acme.com",
"version": "1.0.0",
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z",
"published_at": "2019-01-01T00:00:00Z",
"logo_url": "https://logo.clearbit.com/acme.com",
"contact_email": "support@acme.com",
"legal_info_url": "https://acme.com/legal",
"description": "Acme is an API for searching and retrieving information about Acme's products.",
"machine_description": "Acme is an API for searching and retrieving information about Acme's products.",
"user_id": "string",
"openapi": "{\"openapi\": \"3.1.0\", \"info\": {\"title\": \"Acme API\"}}"
}get/packages/{packageId}/openapi
Returns an OpenAPI spec
Path parameters
- Name
packageId- Type
- string
- Required
- Description
Package id
- Name
format- Type
- string
- Description
Format of the OpenAPI spec (default json)
Response
JSON
{
"openapi": "string",
"info": {
"title": "string",
"version": "string",
"description": "string"
}
}get/packages/{packageId}/ai-plugin
Returns an OpenAI plugin manifest
Path parameters
- Name
packageId- Type
- string
- Required
- Description
Package id
Response
JSON
{
"schema_version": "string",
"name_for_human": "string",
"name_for_model": "string",
"description_for_human": "string",
"description_for_model": "string",
"auth": {
"type": "string"
},
"api": {
"type": "string",
"url": "string",
"is_user_authenticated": true
},
"logo_url": "string",
"contact_email": "string",
"legal_info_url": "string"
}Ai Plugins
get/ai-plugins/search
Searches packages and responds with the ai-plugin manifest
Path parameters
- Name
limit- Type
- integer
- Description
How many package to return per page (default 10)
- Name
query- Type
- string
- Required
- Description
Search query
Response
JSON
[
{
"schema_version": "string",
"name_for_human": "string",
"name_for_model": "string",
"description_for_human": "string",
"description_for_model": "string",
"auth": {
"type": "string"
},
"api": {
"type": "string",
"url": "string",
"is_user_authenticated": true
},
"logo_url": "string",
"contact_email": "string",
"legal_info_url": "string"
}
]get/ai-plugins/lookup
Looks up ai-plugins by package ids
Path parameters
- Name
ids- Type
- string
- Description
CSV list of package ids
Response
JSON
[
{
"schema_version": "string",
"name_for_human": "string",
"name_for_model": "string",
"description_for_human": "string",
"description_for_model": "string",
"auth": {
"type": "string"
},
"api": {
"type": "string",
"url": "string",
"is_user_authenticated": true
},
"logo_url": "string",
"contact_email": "string",
"legal_info_url": "string"
}
]