K

openpm

A newer version of this packageis available.
Viewing version
Latest version
Domain
OpenAPI file
Search for other APIs.

Versions

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": "string",
      "machine_name": "string",
      "domain": "string",
      "openapi": "string",
      "version": "string",
      "created_at": "string",
      "updated_at": "string",
      "published_at": "string",
      "logo_url": "string",
      "contact_email": "string",
      "legal_info_url": "string",
      "description": "string",
      "machine_description": "string",
      "user_id": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "limit": 0
}

post
/packages

Creates a package

Body params

Name
id
Type
string
Required
Name
name
Type
string
Name
machine_name
Type
string
Name
domain
Type
string
Name
openapi
Type
string
Name
version
Type
string
Name
created_at
Type
string
Name
updated_at
Type
string
Name
published_at
Type
string
Name
logo_url
Type
string
Name
contact_email
Type
string
Name
legal_info_url
Type
string
Name
description
Type
string
Name
machine_description
Type
string
Name
user_id
Type
string

Response

JSON
{
  "id": "string",
  "name": "string",
  "machine_name": "string",
  "domain": "string",
  "openapi": "string",
  "version": "string",
  "created_at": "string",
  "updated_at": "string",
  "published_at": "string",
  "logo_url": "string",
  "contact_email": "string",
  "legal_info_url": "string",
  "description": "string",
  "machine_description": "string",
  "user_id": "string"
}

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": "string",
      "machine_name": "string",
      "domain": "string",
      "openapi": "string",
      "version": "string",
      "created_at": "string",
      "updated_at": "string",
      "published_at": "string",
      "logo_url": "string",
      "contact_email": "string",
      "legal_info_url": "string",
      "description": "string",
      "machine_description": "string",
      "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": "string",
    "machine_name": "string",
    "domain": "string",
    "openapi": "string",
    "version": "string",
    "created_at": "string",
    "updated_at": "string",
    "published_at": "string",
    "logo_url": "string",
    "contact_email": "string",
    "legal_info_url": "string",
    "description": "string",
    "machine_description": "string",
    "user_id": "string"
  }
]

get
/packages/{packageId}

Returns a package

Path parameters

  • Name
    packageId
    Type
    string
    Required
    Description

    Package id

Response

JSON
{
  "id": "string",
  "name": "string",
  "machine_name": "string",
  "domain": "string",
  "openapi": "string",
  "version": "string",
  "created_at": "string",
  "updated_at": "string",
  "published_at": "string",
  "logo_url": "string",
  "contact_email": "string",
  "legal_info_url": "string",
  "description": "string",
  "machine_description": "string",
  "user_id": "string"
}

post
/packages/{packageId}

Updates a package

Path parameters

  • Name
    packageId
    Type
    string
    Required
    Description

    Package id

Body params

Name
id
Type
string
Required
Name
name
Type
string
Name
machine_name
Type
string
Name
domain
Type
string
Name
openapi
Type
string
Name
version
Type
string
Name
created_at
Type
string
Name
updated_at
Type
string
Name
published_at
Type
string
Name
logo_url
Type
string
Name
contact_email
Type
string
Name
legal_info_url
Type
string
Name
description
Type
string
Name
machine_description
Type
string
Name
user_id
Type
string

Response

JSON
{
  "id": "string",
  "name": "string",
  "machine_name": "string",
  "domain": "string",
  "openapi": "string",
  "version": "string",
  "created_at": "string",
  "updated_at": "string",
  "published_at": "string",
  "logo_url": "string",
  "contact_email": "string",
  "legal_info_url": "string",
  "description": "string",
  "machine_description": "string",
  "user_id": "string"
}

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"
}