Show API
in Your Docs

Authentication

YOUR API KEYS

API KEY	LABEL	LAST USED
••••cd3fe	development	6/2/23 5:39 PM
••••2k9pp	staging	5/30/23 2:39 AM
••••f65v9	production	5/30/23 2:39 AM
••••9dd8n	test	Never
••••4ip00	test-2	Never

API Key Quick Start

API keys are an essential part of your custom Journey Map workflow, api scripts, or any other integrations you choose to build with the Owlbert API. Thankfully, the Owlbert dashboard and Owlbert docs provide a variety of tools so you can quickly get up and running with authenticated API requests.

Making An Authentication API Request 🪄

The first thing you should do is log into the Owlbert docs if you haven’t already done so. Any API keys associated with your account should automatically be populated above. Here’s what mine look like when I’m logged in:

A One-Stop-Shop

The Authentication page is where developers can select one of their API keys and get started in a snap.

Just

With pre-populated API keys and an interactive API reference, your developers can make that first successful API call directly from your docs.

The Developers
Behind the Docs

ENDPOINT

/tours368

/tours/{tour_id}/stops163

/feed82

More 144

METHOD

PUT

PUT400

GET

GET309

POST

POST125

DELETE

DELETE3

More 3

STATUS

200 - OK710

201 - Created78

400 - Bad Request21

503 - Service Unavailable16

More 4

USER AGENT

RestSharp/108.0.3.0139

rdme-github/8.6.176

rdme/8.6.165

rdme-github/7.2.036

More 441

LAST REQUEST	API KEY	EMAIL	COMPANY
now	••••8d0d	••••@scale.ai	Scale AI
now	••••3994	••••@notion.so	Notion
now	••••37ce	••••@miro.com	Miro
now	••••e330	••••@webflow.com	Webflow
1m ago	••••31ac	••••@travelperk.com	TravelPerk
2m ago	••••704d	••••@yalo.com	Yalo
2m ago	••••61fa	••••@bloomreach.com	Bloomreach
4m ago	••••7aa7	••••@gusto.com	Gusto
5m ago	••••a07a	anonymous	-
7m ago	••••bf54	••••@afterpay.com	Afterpay
9m ago	••••8271	••••@personio.com	Personio
9m ago	••••b9b8	••••@percy.com	Percy
11m ago	••••1311	••••@dialpad.com	Dialpad
12m ago	••••22e1	••••@samsara.com	Samsara
12m ago	••••505a	••••@blend.com	Blend
12m ago	••••a0e2	••••@render.com	Render
12m ago	••••c1e3-	••••@mixpanel.com	Mixpanel

host	travel.hoot.at
connection	close
accept-encoding	gzip
user-agent	python-requests/2.28.2
accept	application/json
cdn-loop	cloudflare

Get Your API in Formation

Filter and find developers in need. Debug requests in realtime to work with developers to resolve issues.

The Developer is
in the Details

Get organized, detailed, request data. Filter requests by endpoint, method, status, and more.

Trusted by more than 3000 leading developer experience teams

Ready to Get Started?

Surface API Keys in Your Docs

Deploy the Personalized Docs Webhook so your users can access their API keys and other helpful data to get started with your API.See How

Analyze API Usage in ReadMe

We’ve got SDKs in Python, Node, and other popular languages to give you a jump start.SDK Docs

FAQs

Can I try it out first?

You get 24 hours worth of API logs history and Try It data for free. All plans can buy additional API logs per month as an add-on to their ReadMe subscription.

How do I see more history?

Developer Dashboard gives you access to up to one year of API logs! Logs can be purchased in 1 million increments for $100/month.

You can add more logs by going to the Upgrade Plan section of your project dashboard. If you happen to hit your limit, you can always purchase more logs to increase capacity. See pricing.

How long are logs stored?

We retain the data from logs associated with trial and unpaid accounts for 3 months, and the data associated with paid accounts for 12 months after cancellation.

Do you store API keys?

API keys are only stored in plain text locally in a dev’s browser. When they’re stored on our server, they’re always hashed. We’ll show you the last 4 digits of a key so that you know which one it is.

Join the 3000+ companies putting developer experience first