How to Use the Playground
Learn how to test CardSight API endpoints, explore features for your app, and use AI assistant prompts to accelerate your integration.
Getting Started
The CardSight AI Playground is a hands-on testing environment where you can explore our REST API without writing any code. Before you can test endpoints, you'll need an API key.
Get Your Free API Key
Sign up for a CardSight AI account to receive your API key. It's free to get started!
Sign up at app.cardsight.aiEnter Your API Key
Click the "Set API Key" button in the header at the top of this page. Paste your API key into the input field and click "Save".
Verify Your Connection
Look for the Connected badge in the header. This confirms your API key is valid and you're ready to test endpoints.
Testing API Endpoints
Most endpoints in the CardSight API have their own detail page where you can learn about them and test with live data.
Finding Endpoints
- Use the sidebar navigation to access quick links like "Identify Cards"
- Click "API Features" to browse all available endpoints organized by category
- Use the search bar on the API Features page to find specific endpoints
Understanding the Endpoint Page
Each endpoint detail page has four tabs:
What the endpoint does and when you might want to use it. Great for understanding the purpose.
Interactive testing! Fill in parameters and make real API calls to see live results.
Parameters, response structure, and code examples in multiple languages.
Copy a prompt to use with AI coding assistants for integration help.
Testing Workflow
- 1Navigate to an endpoint and click the "Try It Out" tab
- 2Fill in the required parameters (look for helpful placeholder examples)
- 3Click the action button to make the API call
- 4View results in the "Results" tab (formatted view) or "JSON Response" tab (raw data)
- 5Copy the cURL command to use the same request elsewhere
Exploring Features for Your App
Whether you're evaluating CardSight for a new project or planning your integration, the playground helps you understand what's possible.
Discover Available Data
Test different endpoints to see exactly what data you'll have access to. Search for cards, look up releases, and explore the catalog.
Plan Your Data Models
View real JSON responses to understand the data structure. Use this to plan how you'll store and display card information.
Use the Pin Feature
When testing, you'll encounter IDs for cards, releases, sets, and more. Click the pin icon next to any ID to save it for later.
- Pinned IDs appear in the bottom panel for quick access
- Use them to test related endpoints (e.g., get release → get release cards)
- Great for exploring relationships between data types
Understanding Endpoint Relationships
Many endpoints work together. Here are common workflows:
Using AI Assistant Prompts
Most endpoints include a ready-to-use prompt for AI coding assistants. This gives your AI the context it needs to help you write integration code, debug issues, and understand the API.
1. Copy the Prompt
Go to any endpoint and click the "AI Assistant Prompt" tab. Click "Copy Prompt" to copy it to your clipboard.
2. Paste to Your AI
Paste the prompt into your AI assistant's chat. This gives it all the context about the endpoint.
3. Ask for Help
Ask your AI to help you write code, explain the response, or debug an issue. It now understands the endpoint!
Works With These AI Tools
What's Included in Each Prompt
- Complete endpoint documentation
- Request parameters and types
- TypeScript & Python SDK examples
- Response structure and fields
- cURL examples for direct API calls
- Tips for common use cases