Documentation

Everything you need to create, test, and share API playgrounds.

Quick Start

Get up and running with TryAPI in under 5 minutes.

1

Sign up for TryAPI

Create your account and start your 7-day free trial.

2

Paste a cURL command

Copy any cURL command from your API documentation.

3

Customize and test

Modify the request, add authentication, and send test requests.

4

Embed in your docs

Add interactive testing to your site. Updates sync automatically.

Documentation

Explore guides and references for all TryAPI features.

Getting Started

Learn the basics of TryAPI and create your first playground in minutes.

cURL Parsing

Master the art of converting cURL commands into interactive playgrounds.

Code Generation

Generate working code snippets in 9 programming languages.

Sharing & Embedding

Embed interactive API playgrounds in your docs. Updates sync automatically.

Authentication

Handle API authentication securely in your playgrounds.

API Reference

Complete reference for the TryAPI REST API.

Creating Your First Playground

Here's an example cURL command you can use to get started:

curl -X POST https://api.stripe.com/v1/charges \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d amount=2000 \
  -d currency=usd \
  -d source=tok_visa \
  -d description="Test charge"

Paste this into the playground creator to see TryAPI in action. It's a test mode Stripe API call that won't charge anything.

Embedding Playgrounds

Add interactive API testing directly to your documentation. When you update a playground in TryAPI, embeds update automatically - no code changes needed.

Iframe Embed

Simple copy-paste solution. Works everywhere HTML is supported.

<iframe
  src="https://try-api.com/p/your-slug/embed"
  width="100%"
  height="500"
  frameborder="0"
></iframe>

Script Embed

More control with data attributes. Supports programmatic mounting.

<div id="tryapi-your-slug"></div>
<script
  src="https://try-api.com/embed.js"
  data-slug="your-slug"
  data-theme="dark"
  data-height="500"
></script>

Customization Options

OptionValuesDescription
themedark, lightColor theme for the embed
heightnumberHeight in pixels (default: 500)
langscurl,js,python...Limit displayed languages
hideBranding1Hide "Powered by TryAPI" (Starter+)

Domain Whitelisting

Pro

Restrict which websites can embed your playgrounds. Add allowed domains in your playground's share settings. Only requests from whitelisted domains will load the embed.

Need Help?

Can't find what you're looking for? We're here to help.

Contact SupportAPI Reference