Prolific API - what markup language is used and how to find study ID

When creating a draft study, what is the markup language for the study description? I would like to specify bold, headers, etc.

Thanks!

Is it possible to get a draft study ID from the online gui? For example, create the draft using the Prolific gui, then publish through the API.

Dear Warren

Welcome to the forum :smiley:

I am not aware of a markup language but the study description is now created with a rich text editor which has bold, underlining, and strickethrough but no colours

The study TITLE appears to be in plain text but you may be able to use

to generate something that looks like bold. I have just tried it, and viewed what it would look like to participants using the “Preview” button at the bottom, and the fake-bold it generates does not appear bold but the fake-italics does appear to look like italics even in the title.

I would like a mark up language. Should you be so kind as to request one I would be grateful.

I am sorry I cannot help more.

Tim

Dear Warren

I don’t know how to get a draft ID. The link to the would-be study in the preview window is greyed out.

BUT… in the study creation page there appears to be a study ID as below

https://app.prolific.co/researcher/workspaces/projects/STUDYID/new-study

And the link to the study will (future tense) be

https://app.prolific.co/studies/STUDYID

If you generate that URL yourself and go to, it will lead to a 404 page no found error however.

Does that help?

Tim

I’m having trouble finding the exact link you’re mentioning, but found a couple others that are similar. For example, when I go to “share,” it gives me this link.

https://app.prolific.co/studies/share/62a9fd15578fd738e3273fc2

is that last portion, “62a9fd15578fd738e3273fc2” plausible for the study ID?

I also see it in the url for the GUI.

https://app.prolific.co/researcher/studies/62a9fd15578fd738e3273fc0

Thanks!

1 Like

Thanks for the response! I’m looking at the API documentation on this link.

https://docs.prolific.co/docs/api-docs/public/#tag/Studies/paths/~1api~1v1~1studies~1/post

When I create the draft of the study in the GUI, I can use the rich text editor and it looks nice. What I’m wondering is if I create it through the API, can I still add bold text, etc? If so, what markup syntax is Prolific looking for?

1 Like

Dear Warren

Sorry. Combined with your other question regarding using the API, I guess that you want to use the markup language, that must exist, in calls to the API.

I have never used the API and the GUI rich text editor doesn’t let us see the source, so my simple answer is, I don’t know.

@Jon when making calls to the API to create studies, what is the markup language used to specify bold, italic and strikethough in the description?

Tim

Warren

Sorry, yes. Before I read this post I figured what you meant and asked Jon. He will be able to find out and tell us, soon I think.

Thank you for the link to the API documentation. I was wondering if the information is in there but you have confirmed it isn’t.

Tim

Warren

Sorry to be slow.

Yes, the “62a9fd15578fd738e3273fc2” is the study ID.

I think t hat the link I shared should work after the study is published and it should be visible in the create study page URL too but the share study link is a good place to find it. Thank you.

Tim

When I create the draft of the study in the GUI, I can use the rich text editor and it looks nice. What I’m wondering is if I create it through the API, can I still add bold text, etc? If so, what markup syntax is Prolific looking for?

Good question! @Warren_Pettine . @Jonas_Anso, might you be able to help with this one?

Hi @Warren_Pettine.

Good question indeed!!!
I did not realise that we had not documented it.

The description is in HTML, we only allow basic formatting tags and anchor links.

We also remove at the moment any inlined CSS.

Give it a try and use the Peview button to see the results and let us know how does that work for you

1 Like