OpenAPI document of this API

Returns

4 fields of the 200 answer

openapistringrequired

infoobjectrequired

2 fields

titlestringrequired

versionstringrequired

pathsobjectrequired

componentsobjectrequired

Responses

200Success

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/openapi.json \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.meta.openapi();

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.meta.openapi()

Response

{
  "openapi": "Example",
  "info": {
    "title": "Validation failed",
    "version": "Example"
  },
  "paths": {},
  "components": {}
}