Introduction
Welcome to the Glyboard API documentation. Our API provides access to state-of-the-art generative models for contextual intelligence, specifically tuned for professional narratives and biographies.
Overview
The Glyboard API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
You can use the API to:
- Generate professional biographies from unstructured data.
- Extract skills and achievements from resumes.
- Fine-tune models on your own corporate data.
Base URL
All API requests should be made to the following base URL:
https://api.vellumfive.com/v1
Authentication
The Glyboard API uses API keys to authenticate requests. You can view and manage your API keys in the Developer Dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
curl https://api.vellumfive.com/v1/models \
-H "Authorization: Bearer YOUR_API_KEY"
Making Requests
You can paste the command below into your terminal to run your first API request. Make sure to replace YOUR_API_KEY with your actual secret API key.
curl https://api.vellumfive.com/v1/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "glyboard-v2",
"prompt": "Write a short professional bio for a software engineer with 5 years of experience in React and Node.js.",
"max_tokens": 150
}'