Language:

Idynic API

The Idynic API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://idynic.com/api/v1
Base URL
https://idynic.com/api/v1

Authentication

The Idynic API uses API keys to authenticate requests. You can manage your API keys in your account settings.

Authentication is performed via the Authorization header using Bearer authentication.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Authenticated request
curl https://idynic.com/api/v1/profile \
  -H "Authorization: Bearer idn_your_api_key"

Errors

Idynic uses conventional HTTP response codes to indicate the success or failure of an API request.

200OK - Request succeeded
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Not allowed to access resource
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Server Error - Something went wrong
Error response
{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: description",
    "request_id": "req_abc123"
  }
}

Profile

The Profile object contains your contact information and work history.

GET/profile
Returns the current user's profile including contact info, work history, skills, education, and certifications.
PATCH/profile

Parameters

namestringFull name
emailstringEmail address
phonestringPhone number
locationstringCity, State
linkedinstringLinkedIn URL
githubstringGitHub URL
websitestringPersonal website URL
Get profile
curl https://idynic.com/api/v1/profile \
  -H "Authorization: Bearer idn_..."
Response
{
  "contact": {
    "name": "Jane Smith",
    "email": "jane@example.com",
    "location": "San Francisco, CA"
  },
  "experience": [...],
  "skills": [...],
  "education": [...]
}

Evidence Blocks

Evidence Blocks represent your skills, achievements, education, and certifications—each with a confidence score indicating how well it's supported by proof.

GET/claims
Returns all evidence blocks for the current user.
Get evidence blocks
curl https://idynic.com/api/v1/claims \
  -H "Authorization: Bearer idn_..."
Response
[
  {
    "id": "clm_abc123",
    "type": "skill",
    "label": "TypeScript",
    "description": "5+ years experience",
    "confidence": 0.92
  },
  {
    "id": "clm_def456",
    "type": "certification",
    "label": "AWS Solutions Architect",
    "confidence": 1.0
  }
]

Targets

Targets represent job postings you're tracking. Add a target, generate a tailored profile, and create shareable links.

GET/opportunities

Query parameters

statusstringoptionalFilter by: tracking, applied, interviewing, offered, rejected
POST/opportunities

Body parameters

descriptionstringrequiredJob description text
urlstringoptionalJob posting URL
POST/opportunities/:id/tailor
Generates a tailored profile for this target based on your identity.
POST/opportunities/:id/share
Creates a shareable link to your tailored profile.

Convenience endpoints

POST /opportunities/add-and-tailor

Add + generate tailored profile

POST /opportunities/add-tailor-share

Add + tailor + create share link (all-in-one)

Add and create share link
curl -X POST https://idynic.com/api/v1/opportunities/add-tailor-share \
  -H "Authorization: Bearer idn_..." \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Senior Software Engineer at Acme..."
  }'
Response
{
  "opportunity": {
    "id": "opp_xyz789",
    "title": "Senior Engineer",
    "company": "Acme Corp",
    "match_score": 0.87
  },
  "share_link": {
    "url": "https://idynic.com/s/abc123",
    "expires_at": null
  }
}

Documents

Upload resumes and career stories to build your identity.

POST/documents/resume

Body (multipart/form-data)

filefilerequiredPDF or DOCX file
POST/documents/story

Body parameters

contentstringrequiredStory text (free-form)
titlestringoptionalOptional title
Upload resume
curl -X POST https://idynic.com/api/v1/documents/resume \
  -H "Authorization: Bearer idn_..." \
  -F "file=@resume.pdf"
Add story
curl -X POST https://idynic.com/api/v1/documents/story \
  -H "Authorization: Bearer idn_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Leading the platform migration",
    "content": "In 2023, I led a team of 5..."
  }'

Shared Profiles

Public endpoints for accessing shared profiles. No authentication required.

GET/shared/:token
Returns the tailored profile for a share link. No auth required.
GET/shared/:token/summary
Returns an AI-generated summary of the candidate for quick review.
Get shared profile
curl https://idynic.com/api/v1/shared/abc123
Summary response
{
  "candidate_name": "Jane Smith",
  "summary": "Senior engineer with 8+ years...",
  "generated_at": "2024-01-15T10:30:00Z"
}