Developers // API v1

Inkference API

Fetch your own profile, projects, skills, photos and more with a secret key, and show them on your personal website.

Get a key Endpoints

Base URL

https://inkference.com/api/v1

Auth

Bearer ink_live_...

Format

JSON, read only (GET)

Rate limit

60 requests / minute / key

Overview

The Inkference API lets each account read its own public profile as JSON. Use it to build a personal website or portfolio that stays up to date with what you post on Inkference: your projects with their images, your skills, experience, education, merits and photo galleries.

A key only ever returns your own data, and only what anyone could already see on your public profile while signed out. It can't change anything.

Getting a key

1Open Settings > Developer API.
2Give the key a name (like "My website") and tap Make key.
3Copy the key right away. It's only shown once. Keys look like ink_live_...

You can have up to 5 keys, rename them, and see when each was last used. Revoking a key stops it right away.

Authentication

Send your key in the Authorization header of every request:

Header

Authorization: Bearer ink_live_your_key_here

An X-API-Key: ink_live_... header works too. Never put the key in the URL: requests with a key in the query string are refused, since URLs end up in logs and browser history.

Keep your key secret

Your key is a secret, like a password. Call the API from your server or build step: a Next.js server component, an API route, a serverless function, or a script that runs before a static build.

The API allows requests from any website (CORS), but if you call it from code that runs in the browser, anyone can open the dev tools and see your key. Keep it in an environment variable and never commit it to GitHub. If it leaks, revoke it in Settings and make a new one.

Examples

The same request in a few setups. Each one reads the key from the INKFERENCE_API_KEY environment variable.

Terminal

curl "https://inkference.com/api/v1/projects?limit=5" \
  -H "Authorization: Bearer $INKFERENCE_API_KEY"

Endpoints

All endpoints are GET and relative to https://inkference.com/api/v1. Successful answers look like { data }, and lists that can be long also have nextCursor. Images come as { url, thumbnail }: the original and a small copy about 400px wide, good for cards.

GET/api/v1/me

Your profile

Your name, username, headline, bio, profile picture, banner, links and resume (if you added one).

Example response

{
  "data": {
    "id": "2b9d6f0e-...",
    "name": "Alex Chen",
    "username": "alex",
    "headline": {
      "title": "Design Engineer",
      "organization": "Rover Team",
      "organizationUrl": "https://inkference.com/enterprise/rover"
    },
    "bio": "Mechanical engineering student. I build robots.",
    "avatar": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/avatar.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/avatar.w400.webp"
    },
    "banner": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/banner.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/banner.w400.webp"
    },
    "links": [
      {
        "url": "https://github.com/alex",
        "host": "github.com"
      }
    ],
    "resume": {
      "url": "https://f005.backblazeb2.com/file/Inkference/raw/u1/resume/resume.pdf",
      "name": "Alex Chen resume.pdf",
      "updatedAt": "2026-09-01T12:00:00.000Z"
    },
    "profileUrl": "https://inkference.com/profile/alex"
  }
}

GET/api/v1/projects

Your projects

Public projects you own or are on the team of, most recently updated first. Each has its images (with small thumbnails), links, skills and a link to its page.

Parameters

limitnumber

How many to return, 1 to 100. Default 20.

cursorstring

The nextCursor from the last page, to get the next one.

rolestring

all (default), owner (only yours) or contributor (only projects you contributed to as a team member). Each project says role and, for contributed ones, contributedAs (your title on the team).

Example response

{
  "data": [
    {
      "id": "8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90",
      "title": "Mars Rover Arm",
      "summary": "A 5 axis robotic arm for the university rover team.",
      "description": "Designed and machined the shoulder and elbow joints...",
      "stage": "BUILDING",
      "status": "IN_PROGRESS",
      "role": "owner",
      "contributedAs": null,
      "startDate": "2026-01-12T00:00:00.000Z",
      "endDate": null,
      "createdAt": "2026-01-12T18:20:11.000Z",
      "updatedAt": "2026-09-30T02:41:07.000Z",
      "icon": {
        "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.jpg",
        "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.w400.webp"
      },
      "banner": {
        "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.jpg",
        "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.w400.webp"
      },
      "gallery": [
        {
          "id": "b71e...",
          "caption": "First test fit",
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.w400.webp"
        }
      ],
      "links": [
        {
          "label": "GitHub",
          "url": "https://github.com/you/rover-arm"
        }
      ],
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": "https://inkference.com/skills/solidworks.svg"
        }
      ],
      "stats": {
        "likes": 24,
        "views": 310
      },
      "url": "https://inkference.com/project/8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90"
    }
  ],
  "nextCursor": "8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90"
}

GET/api/v1/projects/:id

One project

Everything from the list, plus the long write-up (Markdown), milestones, and work: your approved entries from the project's Work tab (when that tab is public).

Parameters

idstring

The project's id (in the path).

Example response

{
  "data": {
    "id": "8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90",
    "title": "Mars Rover Arm",
    "summary": "A 5 axis robotic arm for the university rover team.",
    "description": "Designed and machined the shoulder and elbow joints...",
    "stage": "BUILDING",
    "status": "IN_PROGRESS",
    "role": "owner",
    "contributedAs": null,
    "startDate": "2026-01-12T00:00:00.000Z",
    "endDate": null,
    "createdAt": "2026-01-12T18:20:11.000Z",
    "updatedAt": "2026-09-30T02:41:07.000Z",
    "icon": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.w400.webp"
    },
    "banner": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.w400.webp"
    },
    "gallery": [
      {
        "id": "b71e...",
        "caption": "First test fit",
        "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.jpg",
        "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.w400.webp"
      }
    ],
    "links": [
      {
        "label": "GitHub",
        "url": "https://github.com/you/rover-arm"
      }
    ],
    "skills": [
      {
        "id": "4d2a...",
        "name": "SolidWorks",
        "icon": "https://inkference.com/skills/solidworks.svg"
      }
    ],
    "stats": {
      "likes": 24,
      "views": 310
    },
    "url": "https://inkference.com/project/8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90",
    "writeup": "## How it works\nThe arm uses cycloidal drives...",
    "milestones": [
      {
        "title": "Shoulder joint",
        "done": true,
        "due": "2026-03-01"
      }
    ],
    "work": [
      {
        "id": "w5c1...",
        "title": "Designed the wrist gearbox",
        "description": "Cycloidal drive, 30:1, printed in PA-CF.",
        "startDate": "2026-02-01T00:00:00.000Z",
        "endDate": "2026-03-10T00:00:00.000Z",
        "createdAt": "2026-03-11T18:20:00.000Z",
        "images": [
          {
            "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.jpg",
            "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.w400.webp"
          }
        ],
        "files": [
          {
            "name": "wrist-gearbox.step",
            "url": "https://f005.backblazeb2.com/file/Inkference/raw/u1/projects/file_1700000000000_ab12cd.step",
            "bytes": 482113,
            "type": "step"
          }
        ],
        "skills": [
          {
            "id": "4d2a...",
            "name": "SolidWorks",
            "icon": null
          }
        ]
      }
    ]
  }
}

GET/api/v1/contributions

Your contributions

Everything you did on projects, newest first: your approved entries from each project's Work tab (on your own projects and ones you're on the team of), with photos, files, skills and the project they belong to. Only public projects whose Work tab is open to everyone. A page can come back a little short; keep following nextCursor.

Parameters

limitnumber

How many to return, 1 to 100. Default 20.

cursorstring

The nextCursor from the last page, to get the next one.

Example response

{
  "data": [
    {
      "id": "w5c1...",
      "title": "Designed the wrist gearbox",
      "description": "Cycloidal drive, 30:1, printed in PA-CF.",
      "startDate": "2026-02-01T00:00:00.000Z",
      "endDate": "2026-03-10T00:00:00.000Z",
      "createdAt": "2026-03-11T18:20:00.000Z",
      "images": [
        {
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.w400.webp"
        }
      ],
      "files": [
        {
          "name": "wrist-gearbox.step",
          "url": "https://f005.backblazeb2.com/file/Inkference/raw/u1/projects/file_1700000000000_ab12cd.step",
          "bytes": 482113,
          "type": "step"
        }
      ],
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": null
        }
      ],
      "project": {
        "id": "8f0c...",
        "title": "Mars Rover Arm",
        "icon": {
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.w400.webp"
        },
        "role": "contributor",
        "contributedAs": "Arm lead",
        "url": "https://inkference.com/project/8f0c..."
      }
    }
  ],
  "nextCursor": null
}

GET/api/v1/skills

Your skills

Skills on your list (listed: true) plus any used in your public projects, experiences or merits, with your level, years and whether you use it now.

Example response

{
  "data": [
    {
      "id": "4d2a...",
      "name": "SolidWorks",
      "icon": "https://inkference.com/skills/solidworks.svg",
      "listed": true,
      "level": "Advanced",
      "category": "Hardware",
      "years": 3,
      "lastUsed": null,
      "usingNow": true,
      "suggestedNow": false,
      "usedIn": {
        "projects": [
          {
            "id": "8f0c...",
            "title": "Mars Rover Arm"
          }
        ],
        "experiences": [],
        "merits": []
      }
    }
  ]
}

GET/api/v1/experience

Your experience

The Experience tab, current ones first. kind is "experience" (one you added), "enterprise" (roles at an enterprise, with positions) or "project" (your title on a project team).

Example response

{
  "data": [
    {
      "kind": "experience",
      "id": "c1f3...",
      "title": "Mechanical Design Intern",
      "organization": "Acme Robotics",
      "organizationUrl": null,
      "website": "https://acme.example/",
      "logo": null,
      "description": "Designed fixtures for the assembly line.",
      "highlights": [
        "Cut fixture cost by 30%"
      ],
      "location": "Toronto, ON",
      "locationType": "On-site",
      "employmentType": "Internship",
      "status": "Complete",
      "current": false,
      "startDate": "2025-05-01T00:00:00.000Z",
      "endDate": "2025-08-31T00:00:00.000Z",
      "verified": false,
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": null
        }
      ]
    },
    {
      "kind": "project",
      "id": "8f0c...",
      "title": "Arm lead",
      "team": "Mechanical",
      "isOwner": true,
      "current": true,
      "startDate": "2026-01-12T18:20:11.000Z",
      "endDate": null,
      "project": {
        "id": "8f0c...",
        "title": "Mars Rover Arm",
        "icon": null,
        "url": "https://inkference.com/project/8f0c..."
      }
    }
  ]
}

GET/api/v1/education

Your education

Schools, degrees and courses, current ones first.

Example response

{
  "data": [
    {
      "id": "e7a0...",
      "school": "University of Toronto",
      "degree": "BASc",
      "fieldOfStudy": "Mechanical Engineering",
      "level": "Bachelor's",
      "activities": "Rover team",
      "location": "Toronto, ON",
      "grade": null,
      "description": null,
      "courses": [
        "MIE243",
        "MIE301"
      ],
      "logo": null,
      "website": null,
      "current": true,
      "startDate": "2024-09-01T00:00:00.000Z",
      "endDate": "2029-04-30T00:00:00.000Z"
    }
  ]
}

GET/api/v1/merits

Your merits

Awards, certificates and papers, newest first.

Example response

{
  "data": [
    {
      "id": "m3b2...",
      "title": "CSWA Certification",
      "issuer": "Dassault Systemes",
      "type": "Certificate",
      "summary": "Certified SolidWorks Associate.",
      "issueDate": "2025-06-10T00:00:00.000Z",
      "expiryDate": null,
      "image": null,
      "link": "https://example.com/certificate",
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": null
        }
      ]
    }
  ]
}

GET/api/v1/galleries

Your photo galleries

Public galleries from your Photos tab, newest first. Each photo has the original, a 400px thumbnail and a 1200px medium size.

Parameters

limitnumber

How many to return, 1 to 100. Default 20.

cursorstring

The nextCursor from the last page, to get the next one.

Example response

{
  "data": [
    {
      "id": "g9d1...",
      "name": "Competition 2026",
      "createdAt": "2026-06-02T14:00:00.000Z",
      "updatedAt": "2026-06-03T09:12:00.000Z",
      "url": "https://inkference.com/gallery/g9d1...",
      "photos": [
        {
          "id": "p1a2...",
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/posts/a.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/posts/a.w400.webp",
          "medium": "https://f005.backblazeb2.com/file/Inkference/image/u1/posts/a.w1200.webp",
          "createdAt": "2026-06-02T14:00:00.000Z"
        }
      ]
    }
  ],
  "nextCursor": null
}

Pagination

/projects and /galleries return pages. Use limit (1 to 100, default 20) to pick the page size. When there are more, the answer has a nextCursor: send it back as cursor to get the next page. On the last page nextCursor is null.

curl "https://inkference.com/api/v1/projects?limit=20&cursor=NEXT_CURSOR" \
  -H "Authorization: Bearer $INKFERENCE_API_KEY"

Errors

Errors use normal HTTP status codes and always have the same shape:

Error

{
  "error": {
    "code": "invalid_key",
    "message": "This key is wrong or was revoked."
  }
}

400invalid_request

A query value is wrong (for example limit=500 or an old cursor).

400key_in_url

The key was put in the URL. Send it in a header instead.

401missing_key

No key was sent.

401invalid_key

The key is wrong or was revoked.

403account_banned

The account is banned, so its keys don't work for now.

404not_found

No such endpoint, or no public project with that id.

405method_not_allowed

The API is read only. Only GET works.

429rate_limited

Too many requests. Wait for the seconds in Retry-After.

500server_error

Something broke on our side. Try again in a moment.

Rate limits and caching

Each key can make 60 requests a minute. Every answer has X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (seconds until the minute resets). Over the limit you get a 429 with a Retry-After header.

Answers can be cached for 60 seconds. Your profile doesn't change every second, so cache on your side too: fetch at build time, or use something like next: { revalidate: 3600 } in Next.js. Your site will be faster and you won't hit the limit.

What's included

Only projects and galleries whose audience is Everyone. Followers only, friends only, custom and private ones are never returned.
Anything under review by our moderators is left out until it's cleared.
Your email, birthday, address and settings are never returned.
Hiding a tab on your profile doesn't hide it from the API. To keep something out, change its audience.
Banned accounts can't use their keys until the ban ends.

Ready to build? Make a key and try the curl example.

Get a key

Developers

Loading the developer docs...

Space fact

Saturn's moon Titan has lakes and rivers made of liquid methane.

Pull to reload

Inkference

Developers // API v1

Inkference API

Fetch your own profile, projects, skills, photos and more with a secret key, and show them on your personal website.

Get a key Endpoints

Base URL

https://inkference.com/api/v1

Auth

Bearer ink_live_...

Format

JSON, read only (GET)

Rate limit

60 requests / minute / key

Overview

A key only ever returns your own data, and only what anyone could already see on your public profile while signed out. It can't change anything.

Getting a key

1Open Settings > Developer API.
2Give the key a name (like "My website") and tap Make key.
3Copy the key right away. It's only shown once. Keys look like ink_live_...

You can have up to 5 keys, rename them, and see when each was last used. Revoking a key stops it right away.

Authentication

Send your key in the Authorization header of every request:

Header

Authorization: Bearer ink_live_your_key_here

An X-API-Key: ink_live_... header works too. Never put the key in the URL: requests with a key in the query string are refused, since URLs end up in logs and browser history.

Keep your key secret

Examples

The same request in a few setups. Each one reads the key from the INKFERENCE_API_KEY environment variable.

Terminal

curl "https://inkference.com/api/v1/projects?limit=5" \
  -H "Authorization: Bearer $INKFERENCE_API_KEY"

Endpoints

GET/api/v1/me

Your profile

Your name, username, headline, bio, profile picture, banner, links and resume (if you added one).

Example response

{
  "data": {
    "id": "2b9d6f0e-...",
    "name": "Alex Chen",
    "username": "alex",
    "headline": {
      "title": "Design Engineer",
      "organization": "Rover Team",
      "organizationUrl": "https://inkference.com/enterprise/rover"
    },
    "bio": "Mechanical engineering student. I build robots.",
    "avatar": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/avatar.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/avatar.w400.webp"
    },
    "banner": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/banner.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/banner.w400.webp"
    },
    "links": [
      {
        "url": "https://github.com/alex",
        "host": "github.com"
      }
    ],
    "resume": {
      "url": "https://f005.backblazeb2.com/file/Inkference/raw/u1/resume/resume.pdf",
      "name": "Alex Chen resume.pdf",
      "updatedAt": "2026-09-01T12:00:00.000Z"
    },
    "profileUrl": "https://inkference.com/profile/alex"
  }
}

GET/api/v1/projects

Your projects

Public projects you own or are on the team of, most recently updated first. Each has its images (with small thumbnails), links, skills and a link to its page.

Parameters

limitnumber

How many to return, 1 to 100. Default 20.

cursorstring

The nextCursor from the last page, to get the next one.

rolestring

all (default), owner (only yours) or contributor (only projects you contributed to as a team member). Each project says role and, for contributed ones, contributedAs (your title on the team).

Example response

{
  "data": [
    {
      "id": "8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90",
      "title": "Mars Rover Arm",
      "summary": "A 5 axis robotic arm for the university rover team.",
      "description": "Designed and machined the shoulder and elbow joints...",
      "stage": "BUILDING",
      "status": "IN_PROGRESS",
      "role": "owner",
      "contributedAs": null,
      "startDate": "2026-01-12T00:00:00.000Z",
      "endDate": null,
      "createdAt": "2026-01-12T18:20:11.000Z",
      "updatedAt": "2026-09-30T02:41:07.000Z",
      "icon": {
        "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.jpg",
        "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.w400.webp"
      },
      "banner": {
        "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.jpg",
        "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.w400.webp"
      },
      "gallery": [
        {
          "id": "b71e...",
          "caption": "First test fit",
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.w400.webp"
        }
      ],
      "links": [
        {
          "label": "GitHub",
          "url": "https://github.com/you/rover-arm"
        }
      ],
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": "https://inkference.com/skills/solidworks.svg"
        }
      ],
      "stats": {
        "likes": 24,
        "views": 310
      },
      "url": "https://inkference.com/project/8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90"
    }
  ],
  "nextCursor": "8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90"
}

GET/api/v1/projects/:id

One project

Everything from the list, plus the long write-up (Markdown), milestones, and work: your approved entries from the project's Work tab (when that tab is public).

Parameters

idstring

The project's id (in the path).

Example response

{
  "data": {
    "id": "8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90",
    "title": "Mars Rover Arm",
    "summary": "A 5 axis robotic arm for the university rover team.",
    "description": "Designed and machined the shoulder and elbow joints...",
    "stage": "BUILDING",
    "status": "IN_PROGRESS",
    "role": "owner",
    "contributedAs": null,
    "startDate": "2026-01-12T00:00:00.000Z",
    "endDate": null,
    "createdAt": "2026-01-12T18:20:11.000Z",
    "updatedAt": "2026-09-30T02:41:07.000Z",
    "icon": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.w400.webp"
    },
    "banner": {
      "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.jpg",
      "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/banner.w400.webp"
    },
    "gallery": [
      {
        "id": "b71e...",
        "caption": "First test fit",
        "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.jpg",
        "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/fit.w400.webp"
      }
    ],
    "links": [
      {
        "label": "GitHub",
        "url": "https://github.com/you/rover-arm"
      }
    ],
    "skills": [
      {
        "id": "4d2a...",
        "name": "SolidWorks",
        "icon": "https://inkference.com/skills/solidworks.svg"
      }
    ],
    "stats": {
      "likes": 24,
      "views": 310
    },
    "url": "https://inkference.com/project/8f0c2a6e-3b1d-4c7a-9e55-0d2b7f1a4c90",
    "writeup": "## How it works\nThe arm uses cycloidal drives...",
    "milestones": [
      {
        "title": "Shoulder joint",
        "done": true,
        "due": "2026-03-01"
      }
    ],
    "work": [
      {
        "id": "w5c1...",
        "title": "Designed the wrist gearbox",
        "description": "Cycloidal drive, 30:1, printed in PA-CF.",
        "startDate": "2026-02-01T00:00:00.000Z",
        "endDate": "2026-03-10T00:00:00.000Z",
        "createdAt": "2026-03-11T18:20:00.000Z",
        "images": [
          {
            "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.jpg",
            "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.w400.webp"
          }
        ],
        "files": [
          {
            "name": "wrist-gearbox.step",
            "url": "https://f005.backblazeb2.com/file/Inkference/raw/u1/projects/file_1700000000000_ab12cd.step",
            "bytes": 482113,
            "type": "step"
          }
        ],
        "skills": [
          {
            "id": "4d2a...",
            "name": "SolidWorks",
            "icon": null
          }
        ]
      }
    ]
  }
}

GET/api/v1/contributions

Your contributions

Parameters

limitnumber

How many to return, 1 to 100. Default 20.

cursorstring

The nextCursor from the last page, to get the next one.

Example response

{
  "data": [
    {
      "id": "w5c1...",
      "title": "Designed the wrist gearbox",
      "description": "Cycloidal drive, 30:1, printed in PA-CF.",
      "startDate": "2026-02-01T00:00:00.000Z",
      "endDate": "2026-03-10T00:00:00.000Z",
      "createdAt": "2026-03-11T18:20:00.000Z",
      "images": [
        {
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/gearbox.w400.webp"
        }
      ],
      "files": [
        {
          "name": "wrist-gearbox.step",
          "url": "https://f005.backblazeb2.com/file/Inkference/raw/u1/projects/file_1700000000000_ab12cd.step",
          "bytes": 482113,
          "type": "step"
        }
      ],
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": null
        }
      ],
      "project": {
        "id": "8f0c...",
        "title": "Mars Rover Arm",
        "icon": {
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/projects/rover/icon.w400.webp"
        },
        "role": "contributor",
        "contributedAs": "Arm lead",
        "url": "https://inkference.com/project/8f0c..."
      }
    }
  ],
  "nextCursor": null
}

GET/api/v1/skills

Your skills

Skills on your list (listed: true) plus any used in your public projects, experiences or merits, with your level, years and whether you use it now.

Example response

{
  "data": [
    {
      "id": "4d2a...",
      "name": "SolidWorks",
      "icon": "https://inkference.com/skills/solidworks.svg",
      "listed": true,
      "level": "Advanced",
      "category": "Hardware",
      "years": 3,
      "lastUsed": null,
      "usingNow": true,
      "suggestedNow": false,
      "usedIn": {
        "projects": [
          {
            "id": "8f0c...",
            "title": "Mars Rover Arm"
          }
        ],
        "experiences": [],
        "merits": []
      }
    }
  ]
}

GET/api/v1/experience

Your experience

The Experience tab, current ones first. kind is "experience" (one you added), "enterprise" (roles at an enterprise, with positions) or "project" (your title on a project team).

Example response

{
  "data": [
    {
      "kind": "experience",
      "id": "c1f3...",
      "title": "Mechanical Design Intern",
      "organization": "Acme Robotics",
      "organizationUrl": null,
      "website": "https://acme.example/",
      "logo": null,
      "description": "Designed fixtures for the assembly line.",
      "highlights": [
        "Cut fixture cost by 30%"
      ],
      "location": "Toronto, ON",
      "locationType": "On-site",
      "employmentType": "Internship",
      "status": "Complete",
      "current": false,
      "startDate": "2025-05-01T00:00:00.000Z",
      "endDate": "2025-08-31T00:00:00.000Z",
      "verified": false,
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": null
        }
      ]
    },
    {
      "kind": "project",
      "id": "8f0c...",
      "title": "Arm lead",
      "team": "Mechanical",
      "isOwner": true,
      "current": true,
      "startDate": "2026-01-12T18:20:11.000Z",
      "endDate": null,
      "project": {
        "id": "8f0c...",
        "title": "Mars Rover Arm",
        "icon": null,
        "url": "https://inkference.com/project/8f0c..."
      }
    }
  ]
}

GET/api/v1/education

Your education

Schools, degrees and courses, current ones first.

Example response

{
  "data": [
    {
      "id": "e7a0...",
      "school": "University of Toronto",
      "degree": "BASc",
      "fieldOfStudy": "Mechanical Engineering",
      "level": "Bachelor's",
      "activities": "Rover team",
      "location": "Toronto, ON",
      "grade": null,
      "description": null,
      "courses": [
        "MIE243",
        "MIE301"
      ],
      "logo": null,
      "website": null,
      "current": true,
      "startDate": "2024-09-01T00:00:00.000Z",
      "endDate": "2029-04-30T00:00:00.000Z"
    }
  ]
}

GET/api/v1/merits

Your merits

Awards, certificates and papers, newest first.

Example response

{
  "data": [
    {
      "id": "m3b2...",
      "title": "CSWA Certification",
      "issuer": "Dassault Systemes",
      "type": "Certificate",
      "summary": "Certified SolidWorks Associate.",
      "issueDate": "2025-06-10T00:00:00.000Z",
      "expiryDate": null,
      "image": null,
      "link": "https://example.com/certificate",
      "skills": [
        {
          "id": "4d2a...",
          "name": "SolidWorks",
          "icon": null
        }
      ]
    }
  ]
}

GET/api/v1/galleries

Your photo galleries

Public galleries from your Photos tab, newest first. Each photo has the original, a 400px thumbnail and a 1200px medium size.

Parameters

limitnumber

How many to return, 1 to 100. Default 20.

cursorstring

The nextCursor from the last page, to get the next one.

Example response

{
  "data": [
    {
      "id": "g9d1...",
      "name": "Competition 2026",
      "createdAt": "2026-06-02T14:00:00.000Z",
      "updatedAt": "2026-06-03T09:12:00.000Z",
      "url": "https://inkference.com/gallery/g9d1...",
      "photos": [
        {
          "id": "p1a2...",
          "url": "https://f005.backblazeb2.com/file/Inkference/image/u1/posts/a.jpg",
          "thumbnail": "https://f005.backblazeb2.com/file/Inkference/image/u1/posts/a.w400.webp",
          "medium": "https://f005.backblazeb2.com/file/Inkference/image/u1/posts/a.w1200.webp",
          "createdAt": "2026-06-02T14:00:00.000Z"
        }
      ]
    }
  ],
  "nextCursor": null
}

Pagination

curl "https://inkference.com/api/v1/projects?limit=20&cursor=NEXT_CURSOR" \
  -H "Authorization: Bearer $INKFERENCE_API_KEY"

Errors

Errors use normal HTTP status codes and always have the same shape:

Error

{
  "error": {
    "code": "invalid_key",
    "message": "This key is wrong or was revoked."
  }
}

400invalid_request

A query value is wrong (for example limit=500 or an old cursor).

400key_in_url

The key was put in the URL. Send it in a header instead.

401missing_key

No key was sent.

401invalid_key

The key is wrong or was revoked.

403account_banned

The account is banned, so its keys don't work for now.

404not_found

No such endpoint, or no public project with that id.

405method_not_allowed

The API is read only. Only GET works.

429rate_limited

Too many requests. Wait for the seconds in Retry-After.

500server_error

Something broke on our side. Try again in a moment.

Rate limits and caching

What's included

Only projects and galleries whose audience is Everyone. Followers only, friends only, custom and private ones are never returned.
Anything under review by our moderators is left out until it's cleared.
Your email, birthday, address and settings are never returned.
Hiding a tab on your profile doesn't hide it from the API. To keep something out, change its audience.
Banned accounts can't use their keys until the ban ends.

Ready to build? Make a key and try the curl example.

Get a key