API Credits

Every SkyCiv user has a maximum number of API credits available, based on their account level. Users can check their usage at any time by visiting their account activity page.

Different functions use a different number of API credits, based on their functionality. Typically, API calls only cost if something substantial is being performed (i.e. solving, member design checks, wind load calculations). Below is a list of the functions and how many API credits they cost to run.


List of functions and associated costs#

FunctionAPI Credits
S3D.session.start0
S3D.session.takeScreenshot0
S3D.model.set0
S3D.model.solve1
S3D.model.repair0
S3D.design.member.getInput0
S3D.design.member.check1
S3D.design.member.optimize1
standalone.member.check1
S3D.design.rc.getInput0
S3D.design.rc.check1
S3D.SB.getLibraryTree0
S3D.SB.buildCustomShape1
wind.getWindSpeed1
wind.getPressures1


Pricing#

Each account level comes with a set number of API credits which can be viewed on the pricing page. If you feel the pricing structure doesn't align with your needs, feel free to email us.



Tracking your Usage#

With every API call, users will also receive a summary of their usage. for that API call. and how much of your monthly quota has been used:

usage-summary.json
{
"monthly_api_credits": {
"quota": 6000,
"total_used": 35,
"used_this_call": 2
}
}

Users can review their API usage at any time from account activity page. This will include a view of your usage limit, and a log of all your API calls: